List Company Segment Items

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

Discloses pagination behavior, return format (paginated JSON array with metadata), and read-only nature. Annotations already indicate read-only and idempotent, so description adds useful context without contradiction.

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?

Concise and well-structured: purpose first, then usage, pagination, required params, and API info. No redundant sentences; each sentence provides essential information.

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?

No output schema, but description adequately explains return value (paginated JSON array of WBS records with metadata. Sufficient for a list operation, and includes API endpoint for reference.

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?

With 100% schema coverage, description adds value by grouping parameters into required vs optional and explaining pagination control. Schema already describes each parameter, but description clarifies usage context.

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?

Clearly states 'List Segment Items for a specific segment' and explains it enumerates Work Breakdown Structure records. Distinguishes itself by specifying the resource (Segment Items) and action, though sibling differentiation is implicit via context.

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?

Specifies use cases: paginated overview, find IDs, filter by query parameters. Also mentions required parameters. Does not explicitly state when not to use but provides clear guidance on appropriate usage.

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