Skip to content

feat(community/tools): add strands-sql — multi-dialect SQL tool for Strands Agents#751

Open
NithiN-1808 wants to merge 1 commit intostrands-agents:mainfrom
NithiN-1808:add-strands-sql-tool
Open

feat(community/tools): add strands-sql — multi-dialect SQL tool for Strands Agents#751
NithiN-1808 wants to merge 1 commit intostrands-agents:mainfrom
NithiN-1808:add-strands-sql-tool

Conversation

@NithiN-1808
Copy link
Copy Markdown

Background

This tool was originally submitted as a PR to strands-agents/tools (#420).
The maintainer @mkmeral suggested publishing it as a standalone community package instead,
which is what this PR adds documentation for.

Summary

Adds strands-sql to the community tools documentation — a general-purpose SQL tool for Strands Agents with multi-dialect support via SQLAlchemy.

What is strands-sql?

strands-sql lets agents interact with SQL databases (PostgreSQL, MySQL, SQLite) through a single unified tool. It supports schema discovery, table inspection, and safe query execution out of the box.

Key Features

  • Multi-dialect support: PostgreSQL, MySQL, and SQLite via SQLAlchemy
  • Safe by default: read-only mode, row limits, query timeouts
  • Table allowlist/blocklist for access control
  • Multiple output formats: Markdown (great for LLMs) and JSON
  • Actions: list_tables, describe_table, schema_summary, query, execute

Links

Changes

  • Added src/content/docs/community/tools/strands-sql.mdx
  • Updated src/config/navigation.yml to include strands-sql under Community > Tools

@mkmeral
Copy link
Copy Markdown
Contributor

mkmeral commented Apr 9, 2026

/strands review

@mkmeral
Copy link
Copy Markdown
Contributor

mkmeral commented Apr 10, 2026

The description section in the mdx requires title, causing CI failure. Can you fix the failures, and update the PR? Afterwards, it looks good to merge

@NithiN-1808
Copy link
Copy Markdown
Author

@mkmeral Fixed — added title.

@github-actions
Copy link
Copy Markdown
Contributor

Documentation Preview Ready

Your documentation preview has been successfully deployed!

Preview URL: https://d3ehv1nix5p99z.cloudfront.net/pr-cms-751/docs/user-guide/quickstart/overview/

Updated at: 2026-04-10T15:18:26.907Z

@agent-of-mkmeral
Copy link
Copy Markdown
Contributor

Hey @NithiN-1808 — thanks for this contribution! The docs page looks great. One thing we noticed: the frontmatter in strands-sql.mdx is missing a few fields required for the page to appear in the community packages catalog. Without these, the page won't be auto-discovered.

📝 Recommended frontmatter update

Update the frontmatter in src/content/docs/community/tools/strands-sql.mdx from:

---
title: strands-sql
project:
  pypi: https://pypi.org/project/strands-sql/
  github: https://github.com/NithiN-1808/strands-sql
  maintainer: NithiN-1808
service:
  name: SQLAlchemy
  link: https://www.sqlalchemy.org/
---

To:

---
title: strands-sql
project:
  pypi: https://pypi.org/project/strands-sql/
  github: https://github.com/NithiN-1808/strands-sql
  maintainer: NithiN-1808
service:
  name: SQLAlchemy
  link: https://www.sqlalchemy.org/
community: true
description: SQL database tool for PostgreSQL, MySQL, and SQLite
integrationType: tool
languages: Python
sidebar:
  label: "sql"
---

The key additions are:

  • community: true — marks it as a community package for catalog discovery
  • integrationType: tool — categorizes it under the Tools table
  • description — shown in the catalog Description column
  • languages: Python — drives the Python/TypeScript checkmarks
  • sidebar.label — controls the sidebar display name

Without these, the getIntegrationEntries(allDocs, 'tool', true) call in community-packages.mdx won't find the page. You can check existing community tool pages like strands-deepgram.mdx for reference.

@mkmeral
Copy link
Copy Markdown
Contributor

mkmeral commented Apr 10, 2026

With the deployed version, I saw one issue. It seems like the tool is not displayed on community packages index

https://d3ehv1nix5p99z.cloudfront.net/pr-cms-751/docs/community/community-packages/

Can you also add these? It will allow the tool to be discovered and displayed in the table

📝 Recommended frontmatter update

Update the frontmatter in src/content/docs/community/tools/strands-sql.mdx from:

---
title: strands-sql
project:
  pypi: https://pypi.org/project/strands-sql/
  github: https://github.com/NithiN-1808/strands-sql
  maintainer: NithiN-1808
service:
  name: SQLAlchemy
  link: https://www.sqlalchemy.org/
---

To:

---
title: strands-sql
project:
  pypi: https://pypi.org/project/strands-sql/
  github: https://github.com/NithiN-1808/strands-sql
  maintainer: NithiN-1808
service:
  name: SQLAlchemy
  link: https://www.sqlalchemy.org/
community: true
description: SQL database tool for PostgreSQL, MySQL, and SQLite
integrationType: tool
languages: Python
sidebar:
  label: "sql"
---

The key additions are:

  • community: true — marks it as a community package for catalog discovery
  • integrationType: tool — categorizes it under the Tools table
  • description — shown in the catalog Description column
  • languages: Python — drives the Python/TypeScript checkmarks
  • sidebar.label — controls the sidebar display name

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants