get_api_endpoint_schema

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

No annotations provided; description details case-insensitivity for method, leading slash stripping for path, case-sensitive lookup, and the return object structure with error handling including did_you_mean hint. Lacks discussion of auth or rate limits, but core behavior is well covered.

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 concise, front-loaded with purpose, and well-structured with Args and Returns sections. Every sentence provides value without waste.

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?

Given the tool's complexity (retrieving a schema), an output schema exists (so return values are documented separately). The description covers input behavior, error handling, and hints at the output structure, making it complete for an agent to use correctly.

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?

With 0% schema description coverage, the description adds essential meaning: case-insensitivity for method, and path processing details (leading slash stripped, case-sensitive lookup). This goes beyond the simple type info in the schema.

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 'Return the full schema for one Cin7 API endpoint' with a specific verb and resource. It distinguishes from sibling tools like invoke, list, and report.

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 when to use (when schema is needed) but does not explicitly provide when-not-to-use or compare with alternatives like invoke_api_endpoint or list_api_endpoints.

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