Get Company Assignments

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

Annotations already indicate readOnlyHint=true. The description adds that it returns a paginated JSON array with pagination metadata and specifies required parameters. It does not discuss side effects, authorization, or rate limits, which are already covered by 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 five sentences with no wasted words. It front-loads the main purpose, then efficiently covers pagination, required parameters, and API reference. 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?

For a read-only list endpoint with comprehensive schema and annotations, the description covers the return format (paginated JSON array with metadata) and required parameters. It lacks differentiation from sibling tools, but is otherwise complete for an agent to use.

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 input schema has 100% parameter description coverage. The description goes beyond schema by highlighting the three required parameters and explicitly mentioning pagination control via page and per_page, adding practical usage guidance.

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 Resource Planning Assignment data for a given company. However, it ambiguously mentions 'fetch the full details of a specific Resource Planning records by its identifier,' implying a single record, while the paginated array return suggests a list. This minor inconsistency reduces clarity.

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 explains how to use pagination and lists required parameters but provides no guidance on when to use this tool versus alternative assignment tools (e.g., get_person_assignments, get_project_assignments). No when-not or exclusion criteria are given.

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