CData Sync MCP Server

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

With no annotations provided, the description carries full burden and does well by disclosing return values for each action (create, update, delete) and listing common errors with troubleshooting guidance. It adds valuable context about SQL dialect requirements, connection verification, and job dependencies, though it could mention permissions or rate limits.

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?

The description is well-structured with clear sections (purpose, returns, common errors) and uses bullet points for readability. Every sentence earns its place, though the common errors section could be slightly more concise. It's appropriately sized for a complex tool.

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?

For a complex mutation tool with 14 parameters and no annotations or output schema, the description provides good coverage: it explains the tool's purpose, return values, and common errors. However, it could better address behavioral aspects like idempotency, side effects, or authentication requirements to be fully complete.

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 description coverage is 100%, so the schema already documents all 14 parameters thoroughly. The description doesn't add any parameter-specific semantics beyond what's in the schema, but it doesn't need to compensate. Baseline 3 is appropriate as the schema does the heavy lifting.

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's purpose with specific verbs ('Create, update, or delete') and resource ('SQL transformations for ELT processing'). It distinguishes itself from sibling tools like 'execute_query' (which runs queries) and 'read_transformations' (which only reads) by emphasizing write operations on transformation configurations.

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?

The description implies usage context through the 'ELT processing' mention and common errors like checking SQL dialect and connections, but it doesn't explicitly state when to use this tool versus alternatives like 'write_jobs' or 'execute_query'. No clear exclusions or prerequisites are provided.

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