get-credential-schema
Retrieve credential data schema for n8n workflows to identify required fields when configuring API connections like cloudflareApi or slackOAuth2Api.
Instructions
Show credential data schema for a specific credential type. The credential type name can be found in the n8n UI when creating credentials (e.g., 'cloudflareApi', 'githubApi', 'slackOAuth2Api'). This will show you what fields are required for creating credentials of this type.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| clientId | Yes | ||
| credentialTypeName | Yes |
Implementation Reference
- src/index.ts:1558-1588 (handler)Executes the get-credential-schema tool by retrieving the N8nClient and calling its getCredentialSchema method to fetch the schema from the n8n API.
case "get-credential-schema": { const { clientId, credentialTypeName } = args as { clientId: string; credentialTypeName: string }; const client = clients.get(clientId); if (!client) { return { content: [{ type: "text", text: "Client not initialized. Please run init-n8n first.", }], isError: true }; } try { const schema = await client.getCredentialSchema(credentialTypeName); return { content: [{ type: "text", text: JSON.stringify(schema, null, 2), }] }; } catch (error) { return { content: [{ type: "text", text: error instanceof Error ? error.message : "Unknown error occurred", }], isError: true }; } } - src/index.ts:680-687 (schema)Input schema definition for the get-credential-schema tool, specifying clientId and credentialTypeName parameters.
inputSchema: { type: "object", properties: { clientId: { type: "string" }, credentialTypeName: { type: "string" } }, required: ["clientId", "credentialTypeName"] } - src/index.ts:677-688 (registration)Tool registration in the ListTools response, including name, description, and input schema.
{ name: "get-credential-schema", description: "Show credential data schema for a specific credential type. The credential type name can be found in the n8n UI when creating credentials (e.g., 'cloudflareApi', 'githubApi', 'slackOAuth2Api'). This will show you what fields are required for creating credentials of this type.", inputSchema: { type: "object", properties: { clientId: { type: "string" }, credentialTypeName: { type: "string" } }, required: ["clientId", "credentialTypeName"] } }, - src/index.ts:375-377 (helper)N8nClient helper method that makes the API request to retrieve the credential schema for a given credential type.
async getCredentialSchema(credentialTypeName: string): Promise<any> { return this.makeRequest(`/credentials/schema/${credentialTypeName}`); }