Get contract status

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

The annotation readOnlyHint=true already indicates read-only behavior. The description adds value by stating exactly what is returned (display status and contract name) and what is not returned, providing clear boundaries beyond the annotation.

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 two sentences, front-loaded with the core purpose, and every sentence serves a purpose: describing the function, noting the HubSpot integration, and clarifying exclusions.

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 simple tool with one parameter, readOnlyHint annotation, and no output schema, the description provides sufficient context: what it returns, how it is looked up, and where to go for more details. It is fully adequate for correct tool 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 coverage is 100% for the single parameter composite_id, which is well-described with pattern and meaning. The description adds no additional parameter details beyond confirming the lookup mechanism, so baseline 3 is appropriate.

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 display status and contract name for one contract by composite ID, and explicitly distinguishes from sibling tools like get_contract_content and list_contracts by noting what it does NOT return.

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 says when to use (to get display status and name by composite ID) and when not to use (for full details, use get_contract_content or list_contracts). It also adds context about being the same lookup used by HubSpot integration.

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