Skip to main content
Glama
duynghien

n8n-custom-mcp

by duynghien

get_credential_schema

Retrieve the required fields and structure for a credential type before creating it.

Instructions

Get required fields and structure for a credential type before creating it

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
credentialTypeYesCredential type name (e.g., "githubApi", "slackApi", "googleSheetsOAuth2Api")

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.2.1

TDQS

A4/5.0
Behavior3/5

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

There are no annotations, so the description carries the behavioral burden. The verb 'Get' conveys read-only behavior, and 'before creating it' suggests no side effects, but the response format, error behavior for unknown credential types, and permissions are not disclosed. This is adequate but minimal.

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?

The description is one concise sentence with no filler. The purpose is front-loaded ('Get required fields and structure') and the usage context ('before creating it') is appended efficiently.

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

Completeness4/5

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

For a single-parameter schema lookup tool, the description covers the essential context: what is retrieved and when to use it. There is no output schema, but the description's 'required fields and structure' gives enough shape expectation; more detail on the returned object would be nice but not necessary for correct invocation.

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

Parameters3/5

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

The input schema already fully describes the single 'credentialType' parameter with examples. The description adds no further parameter-level detail, which is acceptable because schema coverage is 100% and no additional semantic burden falls on the description.

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?

The description clearly states the action ('Get'), the resource ('credential type'), and the deliverable ('required fields and structure'). It is easily distinguished from sibling tools like create_credential or get_node_schema because it explicitly targets credential-type schema retrieval.

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?

The phrase 'before creating it' gives clear temporal context, telling an agent to call this before create_credential. It does not explicitly mention alternatives or when not to use it, but the context is strong enough for the main use case.

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