Show Company WBS Segment

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

Beyond the readOnlyHint annotation, the description adds 'Read-only — it changes nothing in Procore,' details failure modes (401, 403, 404), the return type (single JSON object), and the defaulting behavior for company_id. This enriches the annotated safety profile with actionable operational context.

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?

Each sentence earns its place: purpose, usage, defaults, resolution, return type, safety, error handling, required params, and endpoint. Information is front-loaded with the main action and is free of fluff.

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?

Covers purpose, usage, parameters, errors, endpoint, and safety. The only gap is the absence of detailed return field descriptions, but since no output schema is provided and it's a straightforward 'show' tool, the description is sufficiently complete for selection and invocation.

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 already covers all parameters (100%), but description adds value by stating that company_id defaults to procore_set_config when omitted, that id must be an existing parent record, and explicitly listing required parameters. This goes beyond the schema's basic path/query descriptions.

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 opens with 'Retrieves a single company WBS segment for the specified Procore company,' using a specific verb and resource. It distinguishes from siblings like list_company_wbs_segments by explicitly scoping to a single known segment and referencing the 'full field set.'

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?

Provides explicit when-to-use guidance: 'Use this when you already know which company WBS segment you want and need its full field set.' It also instructs to resolve id via the matching list tool first and notes the company_id default from procore_set_config, giving clear context and prerequisites.

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