n8n_get_credential_schema
Retrieve the schema for a specific credential type to understand required fields and structure for authentication setup.
Instructions
Get the schema for a credential type
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| credentialTypeName | Yes | Credential type name |
Implementation Reference
- src/n8n-client.ts:147-150 (handler)The actual implementation of the credential schema retrieval logic in the n8n client.
async getCredentialSchema(credentialTypeName: string): Promise<any> { const response = await this.client.get(`/credentials/schema/${credentialTypeName}`); return response.data; } - src/index.ts:637-645 (registration)Registration of the n8n_get_credential_schema tool and its input schema.
{ name: 'n8n_get_credential_schema', description: 'Get the schema for a credential type', inputSchema: { type: 'object', properties: { credentialTypeName: { type: 'string', description: 'Credential type name' }, }, required: ['credentialTypeName'], - src/index.ts:199-205 (handler)Handler logic for n8n_get_credential_schema in the tool execution switch statement.
case 'n8n_get_credential_schema': { if (!args?.credentialTypeName) throw new Error('credentialTypeName is required'); const result = await n8nClient.getCredentialSchema(args.credentialTypeName as string); return { content: [{ type: 'text', text: formatResponse(result) }], }; }