Skip to main content
Glama

n8n_get_credential_schema

Retrieve the JSON schema for any n8n credential type to identify required fields before creating a credential.

Instructions

Fetch the JSON schema for a credential type via GET /credentials/schema/{credentialTypeName}. Returns the raw JSON Schema document describing the required data shape (e.g. freshdeskApi requires { apiKey, domain }). Use this BEFORE calling n8n_create_credential so you know what fields to populate. 404 on unknown type returns { ok: false, reason: 'not_found' }. 401 surfaces the admin/owner role requirement.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
credentialTypeNameYesn8n credential type name (e.g. 'githubApi', 'slackOAuth2Api').
Behavior4/5

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

With no annotations, description discloses GET method, raw JSON Schema return, error responses (404 with reason, 401 requiring admin/owner role). Suffices for agent to understand behavior.

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

Conciseness5/5

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

Two sentences, first states purpose and endpoint, second gives usage and error info. No wasted words, front-loaded.

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

Completeness5/5

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

For a single-parameter tool without output schema, description covers return type, errors, usage order. Complete and sufficient.

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

Parameters4/5

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

Schema coverage is 100% with parameter description. Description adds example (freshdeskApi requires { apiKey, domain }) providing meaningful context beyond schema alone.

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

Purpose5/5

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

Description clearly states 'Fetch the JSON schema for a credential type', specifying the HTTP endpoint and resource. It distinguishes from sibling tools like listing or using credentials, and gives context for use before creation.

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

Usage Guidelines4/5

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

Explicitly says 'Use this BEFORE calling n8n_create_credential' and mentions error responses (404, 401). Provides clear context for when to use, though no explicit alternatives for when not to use.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/lidless-labs/n8n-ops-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server