Get Workflow Data

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

Annotations already provide readOnlyHint=true, destructiveHint=false, idempotentHint=true, openWorldHint=true. The description adds that it returns a paginated JSON array with pagination metadata, which is useful context. But it does not disclose other behavioral aspects like error handling, rate limits, or access requirements.

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 (4 sentences) and front-loaded with purpose. Every sentence provides essential information: what it returns, how to use, pagination, required params, and API endpoint. No wasted words.

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 no output schema, the description explains it returns a paginated JSON array with metadata. It mentions the API endpoint and covers usage. For a 4-parameter tool with rich annotations, this is fairly complete. Minor improvement would be to describe the attributes returned.

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?

Input schema has 100% description coverage for all 4 parameters. The description only mentions required parameters and pagination control (page, per_page), adding no new meaning beyond what the schema already provides. Baseline 3 is appropriate.

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 it returns attributes related to submittal workflow state for a specific Submittal by identifier. It uses specific verbs ('Returns', 'fetch') and specifies the resource ('Submittals'). However, it does not explicitly differentiate from sibling tools like list_submittals or show_submittal.

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 says 'Use this to fetch the full details of a specific Submittals by its identifier,' which implies when to use. However, it does not provide exclusions or mention alternative tools for different purposes, nor does it offer guidance on when not to use this tool.

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