Get a credential type's data schema

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

No annotations are present, so the description carries the full burden. It discloses that the tool returns a JSON schema indicating required fields and that the result is used as the `data` payload for credential creation. However, it does not mention error behavior, authentication needs, or the exact structure of the returned schema, leaving some behavioral traits implicit.

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 no filler. The first sentence states the core function, and the second provides usage guidance and an example. Information is front-loaded and every sentence earns its place.

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 simple one-parameter tool, the description covers what it does, what it returns (a JSON schema), and when to use it. The lack of an output schema is mitigated by the explicit mention that it returns a 'JSON schema'. A minor gap is not showing an example of the returned schema structure, but the tool's simplicity makes this acceptable.

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 only provides the type (string) for `credentialTypeName`, with 0% coverage in the description. The description adds meaning by clarifying that it represents a credential type and provides an example ('slackOAuth2Api'), enabling the agent to understand and populate the parameter correctly.

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 specifies the exact action ('Get the JSON schema') and resource ('for a credential type'), with a concrete example ('slackOAuth2Api'). It clearly differentiates from sibling tools like n8n_get_credential (which fetches an existing credential) and n8n_create_credential (which creates one) by focusing on the schema lookup.

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?

It explicitly states when to use the tool: 'Use this before n8n_create_credential to know what `data` to send.' This names the relevant alternative and provides a clear contextual workflow, satisfying the 'explicit when/alternatives' criterion.

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