deploy-metadata

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

With no annotations, the description must disclose behavioral traits. It only says 'Deploy', implying mutation, but does not mention side effects, authorization needs, async behavior, or what happens on error beyond what is hinted in options schema.

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 a single sentence with no fluff, efficiently conveying the basic action. However, it could be slightly expanded to include critical behavioral context without significant bloat.

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 complex tool with nested objects and multiple deployment modes, the description is overly minimal. It omits return value, deployment behavior (async/sync), and does not explain the two distinct input formats (metadata objects vs file paths).

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 50%, but the description adds no value beyond the schema: it merely restates the purpose. It does not explain how to specify components or the meaning of options like checkOnly.

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 verb 'Deploy' and the resource 'metadata components to Salesforce org'. It distinguishes from siblings like 'retrieve-metadata' which does the opposite, but does not explicitly differentiate from 'deploy-bundle'.

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?

No guidance is provided on when to use this tool versus alternatives, such as 'deploy-bundle' or 'retrieve-metadata'. No prerequisites or context for usage are mentioned.

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