Skip to main content
Glama

n8n: Get credential schema

n8n_get_credential_schema
Read-only

Retrieve a credential type's schema to identify required fields before configuring credentials for a specified site.

Instructions

[UNIFIED] Get the schema for a credential type. Shows required fields.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "site": "<site>",
      "credential_type": "<credential_type>"
    },
    "name": "n8n_get_credential_schema"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteYes
credential_typeYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv3.14.0
  2. Removedv3.13.1
  3. First observedv3.4.0

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description contributes that the result enumerates required fields, which is genuinely useful behavioral context, but it says nothing about what else the schema returns or whether the lookup can fail for unknown credential types.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, front-loaded with the purpose. The unexplained '[UNIFIED]' tag is the only wasted token, so the text is otherwise efficient and easy to scan.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple two-parameter read tool with no output schema, the description covers the basic job. It is still incomplete on the ambiguity that matters most here: the meaning of the required 'site' parameter and what a returned schema structure contains.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so neither parameter is documented anywhere. 'credential_type' is largely self-explanatory from its name, but 'site' gets no explanation at all — the agent cannot tell whether it is an instance URL, an alias, or something else — and the description does nothing to fill that gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource — getting the schema for a credential type — and adds that it shows required fields, which distinguishes it in spirit from n8n_get_credential, which fetches an actual credential. It does not explicitly name that sibling, and the '[UNIFIED]' prefix is unexplained noise, but the core purpose is clear.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

There is no explicit when-to-use guidance, no mention of when to call this instead of n8n_get_credential, and no statement of prerequisites. 'Shows required fields' only weakly implies a discovery use case before creating a credential; the agent must infer the rest.

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

Deploy Server

Other Tools