Get All Bid Board Projects

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

The description adds context beyond annotations by stating it returns a paginated JSON array with pagination metadata and required parameters. However, the misleading statement about fetching a specific record reduces transparency. Annotations already indicate readOnlyHint and idempotentHint.

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 moderately concise but includes unnecessary technical details like the full API endpoint. The misleading sentence about fetching a specific record wastes space and could be removed. It could be more focused on the listing behavior.

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?

The description explains the return format (paginated JSON array) and pagination metadata, which is good since there is no output schema. However, it does not describe error handling, authentication, or the structure of individual records. The misleading sentence reduces overall completeness.

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?

The schema covers 100% of parameters with descriptions. The description adds value by explaining pagination control with page and per_page, and explicitly states that company_id is required. This helps the agent understand how to use the parameters effectively.

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 starts with 'Get all Bid Board projects' which is clear, but then incorrectly states 'Use this to fetch the full details of a specific Bid Board records by its identifier'. This contradicts the tool name and purpose, as the tool lists all projects and has no identifier parameter. It does not explicitly distinguish from sibling tools like get_bid_board_project_by_id.

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 provides no guidance on when to use this tool versus alternatives. It incorrectly suggests it is for fetching a specific record, which is misleading. There is no mention of when not to use it or how to decide between this and get_bid_board_project_by_id.

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