Create Path Assistant (Sales Path)

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

Annotations already indicate a write operation (readOnlyHint=false) and idempotency (idempotentHint=true). Description adds meaningful context about the Metadata API, optional path item components, and activation behavior, going beyond structured annotations 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?

Two sentences with zero filler. Front-loads the core purpose and then elaborates on key behaviors, making it both concise and well-structured.

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 6-parameter tool with no output schema, the description explains the main configuration elements (path items, activation) and aligns with annotations. It doesn't cover permissions or failure modes, but the annotations handle safety essentials, making it reasonably complete.

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 provides 100% coverage, so baseline is 3. Description adds relational semantics by explaining that pathItems correspond to each picklist value and can include guidance text, info titles, and key fields, plus linking objectName and fieldName to a picklist field.

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?

Description clearly states the specific verb 'Creates' with resource 'Path Assistant' and context 'for a Salesforce object picklist field via the Metadata API'. This distinguishes it from sibling creation tools and matches the title.

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?

Description implies usage context (creating a path assistant for a picklist field) and mentions activation, but does not explicitly compare with alternatives or provide exclusions. Clear context is present, satisfying a 4.

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