List Submittal Packages On A Project

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

Annotations already provide readOnlyHint, destructiveHint, idempotentHint. The description adds that the tool returns a paginated JSON array with pagination metadata and controls (page/per_page), which is useful behavioral context beyond annotations.

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 with 4 sentences, each earning its place. It front-loads the purpose, then adds usage guidance, return type, and API details. 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 mentions the return type (paginated JSON array with metadata) and API endpoint. Parameter details are fully covered by schema. It could elaborate on filter parameters, but overall it's complete for a list 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 coverage is 100%, so baseline is 3. The description does not add significant meaning beyond what the schema provides; it notes that project_id is required and mentions pagination parameters, but these are already 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 the verb 'Return a list' and the resource 'Submittal Packages from a specified Project'. It distinguishes from siblings (e.g., list_submittals_on_a_project) by specifying 'Submittal Packages' and mentions use cases like paginated overview and filtering.

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 explicitly says when to use: 'enumerate Submittals when you need a paginated overview, to find IDs, or to filter by query parameters'. However, it does not mention when not to use or provide alternatives, which would improve guidance.

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