Encode a configuration

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

With no annotation hints (readOnly, destructive, etc.), the description carries the burden of behavioral disclosure. It states the tool produces an encoded string, but doesn't mention any side effects, error behavior, or whether it's a pure transformation. For a simple encoding utility, this is adequate but not rich; it could mention that it has no side effects.

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, clear sentence with no wasted words. It front-loads the action ('Turn... into...') and immediately communicates the output's purpose. Perfectly concise for a simple utility.

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 straightforward encoding tool, the description covers the essential purpose. It doesn't describe the exact format of the encoded string or any constraints, but given the tool's simplicity and other context (schema covers parameters), it's sufficiently complete. No output schema exists, but the return value is implied as an encoded string.

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 all parameters are documented in the input schema. The description does not add extra meaning beyond what the schema provides; it generically refers to 'configuration parameter values' without specific details. With high schema coverage, 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 the tool's function: converting configuration parameter values into an encoded string used by other tools. It identifies the resource (configuration) and the specific action (encode), and distinguishes itself from sibling tools like onshape_get_configuration by noting it produces a string others accept.

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 when to use it: when you need to provide a `configuration` string to other tools. It doesn't explicitly name alternatives or say when not to use it, but the context of 'other tools accept' gives clear guidance. No exclusions are stated, but the purpose is evident.

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