Skip to main content
Glama
sql-mcp

sql-mcp

by hogiabao2601

search_schema

Read-only

Find tables and columns by keyword in their names across a database or all non-system databases to locate relevant schema objects.

Instructions

Find tables and columns whose NAME contains the keyword (case-insensitive). Searches the given/default database, or every non-system database if none is set. Max 100 hits each.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "keyword": "<keyword>"
    },
    "name": "search_schema"
  }
}

Input Schema

NameRequiredDescriptionDefault
schemaNo
keywordYes
profileNo
databaseNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and openWorldHint=false, so the safety profile is covered. The description still adds real behavioral detail beyond the annotations: matching is case-insensitive, only NAME is matched, non-system databases are enumerated when no database is set, and results are capped at 100 hits each. Return shape and the meaning of 'each' remain unstated.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tight sentences, front-loaded with what is matched and followed by scope and the result cap. No filler, no restatement of the tool name.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a four-parameter tool at 0% schema coverage with no output schema, the description leaves meaningful holes: the schema and profile parameters are unexplained and the result format ('max 100 hits each' — each what?) is ambiguous. It is adequate for a simple read-only lookup but not fully complete.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description carries the burden, and it only covers two of four parameters: keyword (name substring, case-insensitive) and database (defaulting/enumeration behavior). The schema and profile parameters get no explanation at all, leaving half the inputs opaque.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description pairs a specific verb ('Find') with a precise resource and matching rule: tables and columns whose NAME contains the keyword, case-insensitive. That NAME-only constraint implicitly separates it from siblings like list_tables and describe_table, so an agent can tell what it returns without opening the schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It explains the scoping default (given/default database, else every non-system database), which is useful usage context, but never states when to prefer this over list_tables or describe_table, nor any exclusion such as searching comments or data values. Usage is implied rather than routed.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.