Skip to main content
Glama

describe_schema

Read-onlyIdempotent

Discover the full database schema: tables, columns, types, primary keys, foreign keys, and indexes. Results cached 1 hour. Call with refresh=true after schema changes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
refreshNoForce live introspection, bypassing cache
connectionNoTarget connection name from this tenant's inventory. Call `list_connections` to see every name + dialect, then match semantically to the user's intent (e.g. 'analytics' → a connection named `*-analytics-*`; 'prod' → a connection with `prod-` prefix). If the user didn't specify, use the tenant's default (first added). Do not invent names — resolve from `list_connections` output.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNo
metaNo
displayNo
summaryNo
insightsNo

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, openWorldHint, and idempotentHint, establishing the safety profile. The description adds worthwhile behavioral context by disclosing the 1-hour cache and the refresh mechanism, which are not captured in annotations. No contradictions found.

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?

The description is two sentences, both dense with value. The first sentence states the core purpose; the second delivers caching and refresh guidance. No filler or redundancy.

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

Completeness5/5

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

Given the tool has an output schema, it need not describe return values. The description covers what the tool returns (schema components), its caching behavior, and when to refresh. The connection parameter is fully specified in the schema, so the combined picture is complete for a read-only introspection tool.

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?

The input schema provides detailed descriptions for both parameters (refresh and connection), giving 100% coverage. The tool description only reinforces the refresh parameter in prose without adding new meaning. Per the rubric, baseline 3 is appropriate when schema description coverage is high and the description does not compensate further.

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 uses a specific verb ('Discover') and resource ('full database schema') and enumerates concrete components (tables, columns, types, primary keys, foreign keys, indexes), which clearly distinguishes it from sibling tools like query_sql or analyze_table. The purpose is immediately understandable and unambiguous.

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

Usage Guidelines4/5

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

The description provides a clear usage context: results are cached for 1 hour, and callers should set refresh=true after schema changes. This implies when to use the tool (schema discovery) and gives a practical condition for refreshing, though it does not explicitly state when not to use it or name alternatives.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A3.9/5.0
Disambiguation4/5

Each tool targets a distinct resource/action, though some overlap exists between analyze_table and data_profile (both profile tables) and between pii_scan and configure_allowlist (both deal with PII). Clear descriptions and separation of quick vs. full analysis mitigate confusion.

Naming Consistency3/5

Most tools follow verb_noun (add_connection, describe_schema, generate_migration), but a notable minority use noun phrases (data_profile, pii_scan, query_firewall, saved_queries, quota, impact_analysis). This mixed convention creates inconsistency, though the naming is still readable.

Tool Count3/5

26 tools is slightly over the 16-25 heavy threshold, but each tool addresses a distinct need across connection management, querying, analysis, security, and performance. While the count feels high, the breadth justifies it; however, it's approaching the 'too many' range.

Completeness5/5

The tool set covers the full lifecycle: connections (add/remove/list/test), querying (query_sql, saved_queries, cross_db_query), schema exploration/migration (describe_schema, generate_migration, impact_analysis), data quality/compliance (analyze_table, data_profile, pii_scan), performance (explain_query, optimize_query, show_locks), and monitoring (watch_table, detect_anomalies). Any gaps are minor, such as no update_connection, but that's not a core need.

Resources