probely_get_credential

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

With no annotations, the description carries the full burden. It discloses that sensitive credentials have their value set to null, and that the tool returns a URI for referencing. This reveals important behavioral traits beyond a simple 'get'. However, it does not mention error cases or permission requirements.

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 three sentences, front-loaded with the primary purpose. Every sentence adds value: first states action, second clarifies output, third gives usage advice. 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?

Given the tool's simplicity (1 parameter, read-only operation) and the presence of an output schema, the description adequately covers key aspects. It explains the null value and URI output. However, it could mention potential errors (e.g., credential not found) for full completeness.

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?

The input schema has one parameter (credentialId) with 0% description coverage. The description does not explain what credentialId is or its expected format (e.g., string format, example). It adds no semantic value beyond the schema parameter name.

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 ('Get a credential by ID') and the resource ('credential'). It specifies the unique identifier (ID) and mentions additional details about the response (value null if sensitive, URI field). Among siblings, it is distinct from other 'get' tools by naming the credential resource explicitly.

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 gives a usage hint ('Use this URI to reference the credential in authentication configs'), but does not provide explicit guidance on when to choose this tool versus alternatives like probely_list_credentials or probely_create_credential. There is no mention of when not to use it or prerequisites.

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