Get project JSON Schema

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

No annotations, so description carries burden. It discloses that the tool provides schema plus notes on cross-field rules not expressible in schema, and indicates the data source (backend validation code) which 'always wins over docs'.

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?

Two efficient sentences with no redundancy. Front-loaded with purpose, then details. Every sentence adds value.

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?

Complete for a simple read-only tool with one optional parameter. No output schema but description adequately describes what is returned (schema + notes). No missing details given tool complexity.

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 parameter with enum and description (100% coverage). Description adds context on what each target value returns, e.g., 'full request envelope (payload XOR template + variables/overrides/webhookUrl)', beyond 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?

Description clearly states 'Get the JSON Schema (draft 2020-12) for a Zvid render payload' with specific verb and resource. It distinguishes from sibling get_* tools by focusing on schema retrieval and cross-field rules.

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?

Provides guidance on using the 'target' parameter for different use cases (project vs render-request) and notes that schema is derived from backend validation code. Lacks explicit when-not-to-use or comparison with other tools like get_element_docs.

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