create_credential

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

The description discloses a key behavioral trait: the n8n API never returns credential secrets, only metadata. This adds value beyond a simple create statement. However, it lacks details on error handling, idempotency, or permission requirements, and the absence of annotations means the description carries full burden, leaving some gaps.

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 two sentences long, each earning its place. The first sentence states the core purpose, and the second provides a critical behavioral note. No unnecessary words or repetition.

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?

The description covers the main prerequisite and a key behavioral aspect. However, it does not mention what the tool returns (likely the created credential metadata), potential uniqueness constraints on the name, or error scenarios. Given the tool's complexity (3 required params, nested data), more context would be beneficial.

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?

With 100% schema description coverage, the baseline is 3. The description adds value by explicitly directing the agent to first use get_credential_schema for the data parameter, which is not fully explained in the schema. This extra guidance improves parameter understanding.

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 (create) and resource (credential), with a specific verb and object. It also mentions a related prerequisite (get_credential_schema), distinguishing it from sibling tools like delete_credential or transfer_credential by being the only creation operation.

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 advises using get_credential_schema first to understand required fields, providing clear context for when to use this tool. However, it does not explicitly state when not to use it or list alternative tools, but no direct alternatives exist for creating credentials.

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