List Project Links

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

Annotations already declare readOnlyHint, destructiveHint, idempotentHint. The description adds context about pagination metadata and the API endpoint (Procore API v2.0 and full URL). No contradictions. It effectively complements the 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 4 sentences, front-loaded with the core action, and well-structured. Each sentence adds information: what it does, when to use, pagination controls, required parameters, and endpoint reference. Minor redundancy but overall concise.

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 and moderate complexity (4 parameters, pagination), the description explains the return type (paginated JSON array with metadata), required parameters, and endpoint. It covers key aspects for an agent to invoke the tool correctly. Could be slightly more specific about 'Home Links' scope.

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 description coverage is 100%, so baseline is 3. The description adds value by explaining how to use page and per_page for pagination and mentioning that the response includes pagination metadata. It also reiterates required parameters, reinforcing their importance.

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 'Returns a list of Home Links on a given project' with a specific verb and resource. It differentiates from siblings like 'list_links' by specifying 'Home Links' and provides context for usage (enumerating Project records, paginating).

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 states when to use: 'to enumerate Project records when you need a paginated overview, to find IDs, or to filter by query parameters'. It also describes pagination controls. While it doesn't explicitly state when not to use or compare directly to siblings, the guidance is clear and helpful.

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