get_sql_definition

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

Descriptions disclose that long SQL is concatenated from multiple rows and that max_length can limit response size. Return fields are listed. No annotations provided, so description carries full burden. Lacks error behavior or performance details but covers key behavioral traits.

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

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

Description is well-structured with a clear summary, context, args, returns, and example. Each sentence adds information without redundancy. Efficiently conveys necessary details.

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

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

Comprehensive given the tool's simplicity: 2 parameters, no output schema, no annotations. Covers what the tool does, parameters, return fields, and example. Missing error handling (e.g., if SQLID not found) but adequate for typical use.

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

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

Schema coverage is 0%, so description adds all meaning. The sql_id parameter is given an example and context (SQL object ID). The max_length parameter explains its purpose and default, providing value beyond the schema's type and default.

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

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

Clearly states the tool gets the SQL text for a PeopleSoft SQL object by SQLID. The verb 'get' and resource 'SQL text' are specific, and it distinguishes from sibling tools like 'search_sql_definitions' which is for searching.

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

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

Implies usage when you have a SQLID, but no explicit when-to-use or when-not-to-use. Does not mention alternatives like 'search_sql_definitions' for finding SQLIDs. Provides context about the data source but no guidance on selection criteria.

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