n8n_get_credential_schema

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

Annotations already declare readOnlyHint=true, and the description is consistent with that by using 'Get'. The description adds no meaningful behavioral detail beyond what the annotations and tool name convey, such as return format, error behavior for unknown credential types, or whether authentication is required.

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, front-loaded sentence with no filler. Every word contributes to explaining the tool's purpose and intended use.

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?

This is a simple, read-only lookup tool with one required parameter and no nested objects. The description is adequate for understanding the basic purpose and expected input, though it does not describe the shape of the returned schema or what happens when an unknown credential type name is supplied.

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 schema describes the only parameter, credentialTypeName, as 'Credential type name', and the description repeats this concept. With 100% schema description coverage, the description does not need to add much, but it also provides no extra guidance on where to find valid credential type names or what format is expected.

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 states a specific action ('Get the schema') on a specific resource ('a credential type') and explains the purpose ('understand required fields'). It clearly distinguishes this from sibling tools like n8n_create_credential and n8n_delete_credential by focusing on schema retrieval rather than credential lifecycle operations.

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 phrase 'to understand required fields' implies this should be used before creating or editing a credential, but there is no explicit guidance on when to use this tool versus alternatives, nor any mention of prerequisites like needing a valid credential type name. The usage context is only implied.

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