salesforce_get_deployment_status

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

With no annotations, the description carries the full burden. 'Poll' implies a read-only, potentially repeated operation, and it discloses what is returned (component counts, errors, test results). However, it does not mention error behavior (e.g., invalid ID), what happens if deployment is still in progress, or any rate limits.

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?

Two short sentences convey the essential information. The first sentence front-loads the action and resource, and the second lists return values. No wasted words.

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?

This is a simple single-parameter tool with no output schema and no annotations. The description adequately explains the purpose and return values, covering component counts, errors, and test results. It could improve by clarifying the 'status' aspect (e.g., states like InProgress, Succeeded) and error conditions, but it is sufficient for basic 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 description coverage is 100%, so the parameter is already well-documented in the schema. The tool description adds little beyond restating 'deployment ID' from the schema, though the schema's reference to salesforce_deploy_metadata is helpful.

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 the action ('Poll the status'), the specific resource ('Salesforce metadata deployment'), and the identifier ('deployment ID'). It also lists key return elements, distinguishing it from other tools like salesforce_deploy_metadata and n8n_get_execution_status.

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 implies usage after a deployment is initiated, and the parameter description explicitly references salesforce_deploy_metadata as the source of the ID. However, it does not provide explicit 'when not to use' or name alternative tools for situations where polling is not appropriate.

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