Get role DDL

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

Annotations already provide readOnlyHint=true and openWorldHint=false. The description adds that it uses pg_get_roledef, returns found=false if role missing, requires PG 19+, and raises on older servers, exceeding what annotations provide.

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?

Concise, front-loaded purpose, no filler. Two paragraphs are reasonable. Could be slightly more structured (e.g., bullet list of return fields) but still efficient.

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?

Covers return structure, error scenarios (not found, older server), and example. With output schema present and annotations, the description is sufficiently complete for a simple DDL tool.

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 covers database parameter with description, but role_name lacks description. Description only includes example to imply usage. With 50% schema coverage, the description could add more detail about role_name format or constraints, but it does not.

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?

The description clearly states the tool returns the CREATE ROLE DDL for a named role using pg_get_roledef. It distinguishes from siblings by specifying the method (PG 19 function, no shell-out) and the exact return structure.

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?

Describes when to use (need role DDL, PG 19+) and how to feature-detect with get_pg19_ddl_status. Warns about error on older servers. Does not explicitly list alternatives like list_roles, but the context is clear enough.

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