strands-sql 0.1.0__py3-none-any.whl

strands_sql/__init__.py

@@ -0,0 +1,5 @@
+"""strands-sql — General-purpose SQL tool for Strands agents."""
+
+from .sql_database import TOOL_SPEC, sql_database
+
+__all__ = ["sql_database", "TOOL_SPEC"]

strands_sql/models.py

@@ -0,0 +1,42 @@
+"""Input/output models for strands-sql."""
+
+from __future__ import annotations
+
+from typing import Literal
+
+from pydantic import BaseModel, Field, model_validator
+
+
+class SqlDatabaseInput(BaseModel):
+    """Validated input for the sql_database tool."""
+
+    action: Literal["list_tables", "describe_table", "schema_summary", "query", "execute"]
+
+    sql: str | None = Field(None, description="SQL string for query/execute actions.")
+    table: str | None = Field(None, description="Table name for describe_table action.")
+
+    connection_string: str | None = Field(
+        None, description="SQLAlchemy connection string. Falls back to DATABASE_URL env var."
+    )
+
+    read_only: bool = Field(True, description="Block write queries when True.")
+    max_rows: int = Field(500, ge=1, le=10_000, description="Max rows returned by query.")
+    timeout: int = Field(30, ge=1, le=300, description="Query timeout in seconds.")
+    output_format: Literal["json", "markdown"] = Field(
+        "markdown", description="Output format for query results."
+    )
+
+    allowed_tables: list[str] | None = Field(
+        None, description="Allowlist — only these tables are accessible."
+    )
+    blocked_tables: list[str] | None = Field(
+        None, description="Blocklist — these tables are never accessible."
+    )
+
+    @model_validator(mode="after")
+    def check_sql_provided(self) -> SqlDatabaseInput:
+        if self.action in ("query", "execute") and not self.sql:
+            raise ValueError(f"'sql' is required when action='{self.action}'.")
+        if self.action == "describe_table" and not self.table:
+            raise ValueError("'table' is required when action='describe_table'.")
+        return self

strands_sql/sql_database.py

@@ -0,0 +1,480 @@
+"""
+strands-sql — General-purpose SQL tool for Strands agents.
+
+Supports PostgreSQL, MySQL, and SQLite via SQLAlchemy.
+"""
+
+from __future__ import annotations
+
+import os
+import re
+import textwrap
+from typing import Any
+
+from sqlalchemy import create_engine, inspect, text
+from sqlalchemy.engine import Engine
+from sqlalchemy.pool import NullPool
+from strands.types.tools import ToolResult, ToolUse
+
+from .models import SqlDatabaseInput
+
+# ---------------------------------------------------------------------------
+# Engine cache — one engine per connection string, reused across tool calls
+# ---------------------------------------------------------------------------
+_ENGINE_CACHE: dict[str, Engine] = {}
+
+
+def _get_engine(connection_string: str, timeout: int) -> Engine:
+    key = connection_string
+    if key not in _ENGINE_CACHE:
+        _ENGINE_CACHE[key] = create_engine(
+            connection_string,
+            poolclass=NullPool,  # safe default; no dangling connections
+            pool_pre_ping=True,  # detect stale connections before use
+            connect_args=_timeout_args(connection_string, timeout),
+        )
+    return _ENGINE_CACHE[key]
+
+
+def _timeout_args(connection_string: str, timeout: int) -> dict:
+    """Return driver-specific timeout connect_args."""
+    cs = connection_string.lower()
+    if cs.startswith("postgresql") or cs.startswith("postgres"):
+        return {"connect_timeout": timeout, "options": f"-c statement_timeout={timeout * 1000}"}
+    if cs.startswith("mysql"):
+        return {"connect_timeout": timeout, "read_timeout": timeout, "write_timeout": timeout}
+    # SQLite and others — no timeout args
+    return {}
+
+
+# ---------------------------------------------------------------------------
+# Security helpers
+# ---------------------------------------------------------------------------
+_WRITE_PATTERN = re.compile(
+    r"^\s*(insert|update|delete|drop|create|alter|truncate|replace|merge|call|exec)\b",
+    re.IGNORECASE,
+)
+_COMMENT_PATTERN = re.compile(r"(--[^\n]*|/\*.*?\*/)", re.DOTALL)
+
+
+def _is_write_query(sql: str) -> bool:
+    clean = _COMMENT_PATTERN.sub("", sql)
+    return bool(_WRITE_PATTERN.match(clean.strip()))
+
+
+def _sanitize_error(exc: Exception) -> str:
+    """Return a safe error message that doesn't leak internal stack details."""
+    msg = str(exc)
+    # Strip file paths and line references
+    msg = re.sub(r'File ".*?"', 'File "<hidden>"', msg)
+    # Truncate very long messages (e.g. full query echoed back by driver)
+    if len(msg) > 400:
+        msg = msg[:400] + "... [truncated]"
+    return msg
+
+
+def _check_table_access(
+    table: str,
+    allowed_tables: list[str] | None,
+    blocked_tables: list[str] | None,
+) -> str | None:
+    """Return an error string if table access is denied, else None."""
+    if allowed_tables and table.lower() not in [t.lower() for t in allowed_tables]:
+        return f"Access denied: table '{table}' is not in allowed_tables."
+    if blocked_tables and table.lower() in [t.lower() for t in blocked_tables]:
+        return f"Access denied: table '{table}' is blocked."
+    return None
+
+
+def _check_sql_table_access(
+    sql: str,
+    allowed_tables: list[str] | None,
+    blocked_tables: list[str] | None,
+) -> str | None:
+    """Best-effort check that a SQL query only touches allowed tables."""
+    if not allowed_tables and not blocked_tables:
+        return None
+    # Extract identifiers after FROM / JOIN — naive but catches the common case
+    identifiers = re.findall(r"(?:from|join)\s+[`\"]?(\w+)[`\"]?", sql, re.IGNORECASE)
+    for tbl in identifiers:
+        err = _check_table_access(tbl, allowed_tables, blocked_tables)
+        if err:
+            return err
+    return None
+
+
+# ---------------------------------------------------------------------------
+# Output formatting
+# ---------------------------------------------------------------------------
+
+
+def _rows_to_markdown(columns: list[str], rows: list[tuple[Any, ...]]) -> str:
+    if not rows:
+        return "*(no rows)*"
+    col_widths = [
+        max(len(c), max((len(str(r[i])) for r in rows), default=0)) for i, c in enumerate(columns)
+    ]
+    header = " | ".join(c.ljust(col_widths[i]) for i, c in enumerate(columns))
+    separator = "-+-".join("-" * w for w in col_widths)
+    data_rows = [
+        " | ".join(str(row[i]).ljust(col_widths[i]) for i in range(len(columns))) for row in rows
+    ]
+    return "\n".join([header, separator] + data_rows)
+
+
+def _format_results(
+    columns: list[str],
+    rows: list[tuple[Any, ...]],
+    output_format: str,
+    max_rows: int,
+    truncated: bool,
+) -> str:
+    note = f"\n\n⚠️  Results truncated to {max_rows} rows." if truncated else ""
+    if output_format == "markdown":
+        return _rows_to_markdown(columns, rows) + note
+    # Default: JSON-like
+    result = [dict(zip(columns, row)) for row in rows]
+    import json
+
+    return json.dumps(result, default=str, indent=2) + note
+
+
+# ---------------------------------------------------------------------------
+# Action implementations
+# ---------------------------------------------------------------------------
+
+
+def _list_tables(
+    engine: Engine,
+    allowed_tables: list[str] | None,
+    blocked_tables: list[str] | None,
+) -> str:
+    inspector = inspect(engine)
+    tables = inspector.get_table_names()
+    views = inspector.get_view_names()
+    all_objects = [("table", t) for t in tables] + [("view", v) for v in views]
+
+    filtered = []
+    for kind, name in all_objects:
+        if allowed_tables and name.lower() not in [t.lower() for t in allowed_tables]:
+            continue
+        if blocked_tables and name.lower() in [t.lower() for t in blocked_tables]:
+            continue
+        filtered.append((kind, name))
+
+    if not filtered:
+        return "No accessible tables or views found."
+    lines = [f"[{kind}] {name}" for kind, name in filtered]
+    return "\n".join(lines)
+
+
+def _describe_table(
+    engine: Engine,
+    table: str,
+    allowed_tables: list[str] | None,
+    blocked_tables: list[str] | None,
+) -> str:
+    err = _check_table_access(table, allowed_tables, blocked_tables)
+    if err:
+        return err
+
+    inspector = inspect(engine)
+    try:
+        columns = inspector.get_columns(table)
+        pk_info = inspector.get_pk_constraint(table)
+        fk_info = inspector.get_foreign_keys(table)
+    except Exception as exc:
+        return f"Error describing table: {_sanitize_error(exc)}"
+
+    pk_cols = set(pk_info.get("constrained_columns", []))
+    lines = [f"Table: {table}", "", "Columns:"]
+    for col in columns:
+        flags = []
+        if col["name"] in pk_cols:
+            flags.append("PK")
+        if not col.get("nullable", True):
+            flags.append("NOT NULL")
+        flag_str = "  [" + ", ".join(flags) + "]" if flags else ""
+        default = f"  default={col['default']}" if col.get("default") is not None else ""
+        lines.append(f"  {col['name']}  {col['type']}{flag_str}{default}")
+
+    if fk_info:
+        lines += ["", "Foreign Keys:"]
+        for fk in fk_info:
+            cols = ", ".join(fk["constrained_columns"])
+            ref_table = fk["referred_table"]
+            ref_cols = ", ".join(fk["referred_columns"])
+            lines.append(f"  ({cols}) → {ref_table}({ref_cols})")
+
+    return "\n".join(lines)
+
+
+def _schema_summary(
+    engine: Engine,
+    allowed_tables: list[str] | None,
+    blocked_tables: list[str] | None,
+    max_tables: int = 30,
+) -> str:
+    inspector = inspect(engine)
+    all_tables = inspector.get_table_names()
+
+    # Apply access filters
+    visible = []
+    for t in all_tables:
+        if allowed_tables and t.lower() not in [x.lower() for x in allowed_tables]:
+            continue
+        if blocked_tables and t.lower() in [x.lower() for x in blocked_tables]:
+            continue
+        visible.append(t)
+
+    truncated_tables = len(visible) > max_tables
+    visible = visible[:max_tables]
+
+    lines = []
+    for table in visible:
+        try:
+            columns = inspector.get_columns(table)
+            pk_info = inspector.get_pk_constraint(table)
+            pk_cols = set(pk_info.get("constrained_columns", []))
+            col_parts = []
+            for col in columns:
+                marker = "*" if col["name"] in pk_cols else ""
+                col_parts.append(f"{marker}{col['name']}:{col['type']}")
+            lines.append(f"{table}({', '.join(col_parts)})")
+        except Exception:
+            lines.append(f"{table}(schema unavailable)")
+
+    summary = "\n".join(lines)
+    if truncated_tables:
+        summary += f"\n\n... (showing {max_tables} of {len(all_tables)} tables)"
+    return summary
+
+
+def _run_query(
+    engine: Engine,
+    sql: str,
+    allowed_tables: list[str] | None,
+    blocked_tables: list[str] | None,
+    max_rows: int,
+    output_format: str,
+    timeout: int,
+) -> str:
+    err = _check_sql_table_access(sql, allowed_tables, blocked_tables)
+    if err:
+        return err
+
+    try:
+        with engine.connect() as conn:
+            result = conn.execute(text(sql).execution_options(timeout=timeout))
+            columns = list(result.keys())
+            rows: list[tuple[Any, ...]] = [tuple(row) for row in result.fetchmany(max_rows + 1)]
+            truncated = len(rows) > max_rows
+            rows = rows[:max_rows]
+            return _format_results(columns, rows, output_format, max_rows, truncated)
+    except Exception as exc:
+        return f"Query error: {_sanitize_error(exc)}"
+
+
+def _run_execute(
+    engine: Engine,
+    sql: str,
+    allowed_tables: list[str] | None,
+    blocked_tables: list[str] | None,
+    timeout: int,
+) -> str:
+    err = _check_sql_table_access(sql, allowed_tables, blocked_tables)
+    if err:
+        return err
+
+    try:
+        with engine.begin() as conn:
+            result = conn.execute(text(sql).execution_options(timeout=timeout))
+            rowcount = result.rowcount
+            return f"OK. Rows affected: {rowcount if rowcount >= 0 else 'unknown'}"
+    except Exception as exc:
+        return f"Execute error: {_sanitize_error(exc)}"
+
+
+# ---------------------------------------------------------------------------
+# Tool entry point — called by the Strands agent runtime
+# ---------------------------------------------------------------------------
+
+TOOL_SPEC = {
+    "name": "sql_database",
+    "description": textwrap.dedent("""\
+        General-purpose SQL tool. Supports list_tables, describe_table,
+        schema_summary, query (SELECT), and execute (write, if enabled).
+        Works with PostgreSQL, MySQL, and SQLite via SQLAlchemy.
+    """),
+    "inputSchema": {
+        "json": {
+            "type": "object",
+            "properties": {
+                "action": {
+                    "type": "string",
+                    "enum": ["list_tables", "describe_table", "schema_summary", "query", "execute"],
+                    "description": "The action to perform.",
+                },
+                "sql": {
+                    "type": "string",
+                    "description": "SQL string for 'query' or 'execute' actions.",
+                },
+                "table": {
+                    "type": "string",
+                    "description": "Table name for 'describe_table' action.",
+                },
+                "connection_string": {
+                    "type": "string",
+                    "description": (
+                        "SQLAlchemy connection string. Falls back to DATABASE_URL env var."
+                    ),
+                },
+                "read_only": {
+                    "type": "boolean",
+                    "description": "Block write queries. Default true.",
+                },
+                "max_rows": {
+                    "type": "integer",
+                    "description": "Max rows returned by 'query'. Default 500.",
+                },
+                "timeout": {
+                    "type": "integer",
+                    "description": "Query timeout in seconds. Default 30.",
+                },
+                "output_format": {
+                    "type": "string",
+                    "enum": ["json", "markdown"],
+                    "description": "Output format for query results. Default 'markdown'.",
+                },
+                "allowed_tables": {
+                    "type": "array",
+                    "items": {"type": "string"},
+                    "description": "Allowlist of table names the agent may access.",
+                },
+                "blocked_tables": {
+                    "type": "array",
+                    "items": {"type": "string"},
+                    "description": "Blocklist of table names the agent may not access.",
+                },
+            },
+            "required": ["action"],
+        }
+    },
+}
+
+
+def sql_database(tool: ToolUse, **kwargs: Any) -> ToolResult:
+    """Strands tool handler for sql_database."""
+    tool_input = tool.get("input", {})
+
+    # Parse and validate input
+    try:
+        params = SqlDatabaseInput(**tool_input)
+    except Exception as exc:
+        return {
+            "toolUseId": tool["toolUseId"],
+            "status": "error",
+            "content": [{"text": f"Invalid input: {exc}"}],
+        }
+
+    # Resolve connection string
+    connection_string = params.connection_string or os.environ.get("DATABASE_URL")
+    if not connection_string:
+        return {
+            "toolUseId": tool["toolUseId"],
+            "status": "error",
+            "content": [
+                {
+                    "text": (
+                        "No connection string provided. Set DATABASE_URL or pass connection_string."
+                    )
+                }
+            ],
+        }
+
+    # Safety: block writes when read_only=True
+    if params.read_only and params.action == "execute":
+        return {
+            "toolUseId": tool["toolUseId"],
+            "status": "error",
+            "content": [
+                {"text": "Write queries are blocked. Set read_only=False to enable execute."}
+            ],
+        }
+
+    if params.read_only and params.action == "query" and params.sql and _is_write_query(params.sql):
+        return {
+            "toolUseId": tool["toolUseId"],
+            "status": "error",
+            "content": [
+                {
+                    "text": (
+                        "Write statement detected in read_only mode. "
+                        "Use action='execute' with read_only=False."
+                    )
+                }
+            ],
+        }
+
+    # Get (or create) engine
+    try:
+        engine = _get_engine(connection_string, params.timeout)
+    except Exception as exc:
+        return {
+            "toolUseId": tool["toolUseId"],
+            "status": "error",
+            "content": [{"text": f"Connection failed: {_sanitize_error(exc)}"}],
+        }
+
+    # Dispatch
+    try:
+        if params.action == "list_tables":
+            result = _list_tables(engine, params.allowed_tables, params.blocked_tables)
+
+        elif params.action == "describe_table":
+            if not params.table:
+                result = "Error: 'table' parameter is required for describe_table."
+            else:
+                result = _describe_table(
+                    engine, params.table, params.allowed_tables, params.blocked_tables
+                )
+
+        elif params.action == "schema_summary":
+            result = _schema_summary(engine, params.allowed_tables, params.blocked_tables)
+
+        elif params.action == "query":
+            if not params.sql:
+                result = "Error: 'sql' parameter is required for query."
+            else:
+                result = _run_query(
+                    engine,
+                    params.sql,
+                    params.allowed_tables,
+                    params.blocked_tables,
+                    params.max_rows,
+                    params.output_format,
+                    params.timeout,
+                )
+
+        elif params.action == "execute":
+            if not params.sql:
+                result = "Error: 'sql' parameter is required for execute."
+            else:
+                result = _run_execute(
+                    engine,
+                    params.sql,
+                    params.allowed_tables,
+                    params.blocked_tables,
+                    params.timeout,
+                )
+        else:
+            result = f"Unknown action: {params.action}"
+
+    except Exception as exc:
+        result = f"Unexpected error: {_sanitize_error(exc)}"
+
+    return {
+        "toolUseId": tool["toolUseId"],
+        "status": "success",
+        "content": [{"text": result}],
+    }

strands_sql-0.1.0.dist-info/METADATA

@@ -0,0 +1,332 @@
+Metadata-Version: 2.4
+Name: strands-sql
+Version: 0.1.0
+Summary: General-purpose SQL tool for Strands agents — supports PostgreSQL, MySQL, and SQLite.
+Project-URL: Homepage, https://github.com/NithiN-1808/strands-sql
+Project-URL: Repository, https://github.com/NithiN-1808/strands-sql
+Project-URL: Issues, https://github.com/NithiN-1808/strands-sql/issues
+Author-email: Nithin R <nithinr1808@gmail.com>
+License: 
+                                         Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+License-File: LICENSE
+License-File: NOTICE
+Keywords: agents,mysql,postgresql,sql,sqlalchemy,sqlite,strands
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: pydantic>=2.0
+Requires-Dist: sqlalchemy>=2.0
+Requires-Dist: strands-agents>=0.1.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.26; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Requires-Dist: sqlalchemy>=2.0; extra == 'dev'
+Provides-Extra: mysql
+Requires-Dist: pymysql>=1.0; extra == 'mysql'
+Provides-Extra: postgres
+Requires-Dist: psycopg2-binary>=2.9; extra == 'postgres'
+Description-Content-Type: text/markdown
+
+# strands-sql
+
+A general-purpose SQL tool for [Strands Agents](https://strandsagents.com) — supports PostgreSQL, MySQL, and SQLite via SQLAlchemy.
+
+## Installation
+
+```bash
+# SQLite (no extra driver needed)
+pip install strands-sql
+
+# PostgreSQL
+pip install "strands-sql[postgres]"
+
+# MySQL
+pip install "strands-sql[mysql]"
+```
+
+## Quick Start
+
+```python
+from strands import Agent
+from strands_sql import sql_database
+
+agent = Agent(tools=[sql_database])
+
+# Discover the schema
+agent.tool.sql_database(action="schema_summary")
+
+# Describe a specific table
+agent.tool.sql_database(action="describe_table", table="users")
+
+# Run a query (returns a markdown table by default)
+agent.tool.sql_database(
+    action="query",
+    sql="SELECT * FROM orders WHERE amount > 100 LIMIT 20",
+)
+```
+
+## Configuration
+
+### Connection String
+
+Pass it directly or set the `DATABASE_URL` environment variable:
+
+```bash
+export DATABASE_URL="postgresql://user:password@localhost:5432/mydb"
+```
+
+```python
+agent.tool.sql_database(
+    action="list_tables",
+    connection_string="sqlite:///./local.db",
+)
+```
+
+## Actions
+
+| Action | Required params | Description |
+|---|---|---|
+| `list_tables` | — | List all tables and views |
+| `describe_table` | `table` | Columns, types, PKs, FKs |
+| `schema_summary` | — | Compact schema of all tables (ideal as LLM context) |
+| `query` | `sql` | Run a SELECT statement |
+| `execute` | `sql`, `read_only=False` | Run a write query (blocked by default) |
+
+## Safety Options
+
+```python
+agent.tool.sql_database(
+    action="query",
+    sql="SELECT * FROM users",
+    read_only=True,                      # Default: True — blocks INSERT/UPDATE/DELETE
+    max_rows=500,                        # Default: 500 — caps result size
+    timeout=30,                          # Default: 30s — kills hung queries
+    allowed_tables=["users", "orders"],  # Allowlist
+    blocked_tables=["secrets"],          # Blocklist
+)
+```
+
+| Option | Default | Description |
+|---|---|---|
+| `read_only` | `True` | Blocks all write queries |
+| `max_rows` | `500` | Maximum rows returned by `query` |
+| `timeout` | `30` | Query timeout in seconds (1–300) |
+| `allowed_tables` | `None` | Allowlist — only these tables are accessible |
+| `blocked_tables` | `None` | Blocklist — these tables are never accessible |
+
+## Output Formats
+
+```python
+# Markdown table (default — great for LLMs)
+agent.tool.sql_database(action="query", sql="SELECT * FROM users", output_format="markdown")
+
+# JSON array
+agent.tool.sql_database(action="query", sql="SELECT * FROM users", output_format="json")
+```
+
+## Development
+
+```bash
+git clone https://github.com/NithiN-1808/strands-sql
+cd strands-sql
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run tests with coverage
+pytest --cov=strands_sql --cov-report=term-missing
+
+# Lint
+ruff check src/ tests/
+
+# Type check
+mypy src/strands_sql/
+```
+
+## License
+
+Apache 2.0

strands_sql-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+strands_sql/__init__.py,sha256=fCXJpBrV2UA9m1t8tGeulIMO7fh0DhhNR1xDciiEjUc,164
+strands_sql/models.py,sha256=NN7JhxOfr0fLP9kfjqZPyo2DJCbggM1yluZDsx51aZ8,1751
+strands_sql/sql_database.py,sha256=sg6RkIvLNjcP8vumV3t_vwcM-lCE33MmVz-uVYBCUjc,17072
+strands_sql-0.1.0.dist-info/METADATA,sha256=HfydC7KO1jW-KA8fmB-_JdGmnfd-ZqrbEITg6B7JFEQ,16011
+strands_sql-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+strands_sql-0.1.0.dist-info/licenses/LICENSE,sha256=iARr8i1bT0uMyFB5rmquVCSjoZmduVLtFSgo_zJbLG0,10317
+strands_sql-0.1.0.dist-info/licenses/NOTICE,sha256=O5Ib3JPZOp2wNGhLCzFU8dS6uUsnW-L-N8y_bX8oW2Y,68
+strands_sql-0.1.0.dist-info/RECORD,,

strands_sql-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any

strands_sql-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

strands_sql-0.1.0.dist-info/licenses/NOTICE

@@ -0,0 +1 @@
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.