n8n-mcp/dist/mcp/tool-docs/workflow_management/n8n-manage-credentials.js

Integration between n8n workflow automation and Model Context Protocol (MCP)

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.n8nManageCredentialsDoc = void 0;
exports.n8nManageCredentialsDoc = {
    name: 'n8n_manage_credentials',
    category: 'workflow_management',
    essentials: {
        description: 'CRUD operations for n8n credentials with schema discovery',
        keyParameters: ['action', 'type', 'name', 'data'],
        example: 'n8n_manage_credentials({action: "getSchema", type: "httpHeaderAuth"}) then n8n_manage_credentials({action: "create", name: "My Auth", type: "httpHeaderAuth", data: {name: "X-API-Key", value: "secret"}})',
        performance: 'Fast - single API call per action',
        tips: [
            'Always use getSchema first to discover required fields before creating credentials',
            'Credential data values are never logged for security',
            'Use with n8n_audit_instance to fix security findings',
            'Pass includeUsage:true on list/get to see which workflows reference each credential',
            'list returns up to 100 per page (limit: 1-100, default 100) - pass the returned nextCursor back as cursor to page further; includeUsage:true scans all pages automatically (capped at 5000 credentials)',
            'Actions: list, get, create, update, delete, getSchema',
        ]
    },
    full: {
        description: `Manage n8n credentials through a unified interface. Supports full lifecycle operations:

**Discovery:**
- **getSchema**: Retrieve the schema for a credential type, showing all required and optional fields with their types and descriptions. Always call this before creating credentials to know the exact field names and formats.

**Read Operations:**
- **list**: List all credentials with their names, types, and IDs. Does not return credential data values. Pass \`includeUsage: true\` to also include the workflows referencing each credential.
- **get**: Get a specific credential by ID, including its metadata. Pass \`includeUsage: true\` to also include the workflows referencing this credential.

**Write Operations:**
- **create**: Create a new credential with a name, type, and data fields. Requires name, type, and data.
- **update**: Update an existing credential by ID. Can update name and/or data fields.
- **delete**: Permanently delete a credential by ID.

**Security:** Credential data values (API keys, passwords, tokens) are never written to logs. The n8n API encrypts stored credential data at rest.`,
        parameters: {
            action: {
                type: 'string',
                required: true,
                description: 'Operation to perform on credentials',
                enum: ['list', 'get', 'create', 'update', 'delete', 'getSchema'],
            },
            id: {
                type: 'string',
                required: false,
                description: 'Credential ID (required for get, update, delete)',
            },
            name: {
                type: 'string',
                required: false,
                description: 'Credential display name (required for create, optional for update)',
            },
            type: {
                type: 'string',
                required: false,
                description: 'Credential type identifier, e.g. httpHeaderAuth, httpBasicAuth, oAuth2Api (required for create and getSchema)',
                examples: ['httpHeaderAuth', 'httpBasicAuth', 'oAuth2Api', 'slackApi', 'gmailOAuth2Api'],
            },
            data: {
                type: 'object',
                required: false,
                description: 'Credential data fields as key-value pairs. Use getSchema to discover required fields (required for create, optional for update)',
            },
            includeUsage: {
                type: 'boolean',
                required: false,
                description: 'For list/get: when true, also return the workflows that reference each credential (workflow id, name, active). On list, this scans all credential pages (up to 5000 credentials; ignores cursor/limit and returns no nextCursor) so the inventory is complete. Triggers a full workflow scan; slower on large instances. Default: false.',
            },
            cursor: {
                type: 'string',
                required: false,
                description: 'For list: pagination cursor from a previous response\'s nextCursor. Use to page beyond the first 100 credentials. Ignored when includeUsage is true.',
            },
            limit: {
                type: 'number',
                required: false,
                description: 'For list: maximum number of credentials to return per page (1-100, default 100 per the n8n API). Ignored when includeUsage is true.',
            },
        },
        returns: `Depends on action:
- list: { credentials: [{id, name, type, createdAt, updatedAt}], count: number, nextCursor?: string }. When nextCursor is present, pass it back as cursor to fetch the next page. With includeUsage=true, the full credential set is scanned across all pages (no nextCursor returned); each credential also has usedIn (array of {id, name, active}) and usageCount (number of distinct workflows), and the response may include usageScanError if the workflow scan failed (base credentials still returned).
- get: Credential object with id, name, type, createdAt, updatedAt. With includeUsage=true, also includes usedIn and usageCount; if the workflow scan fails, usageScanError is set on the response and usedIn/usageCount are omitted.
- create: Created credential object with id, name, type
- update: Updated credential object
- delete: Success confirmation message
- getSchema: Schema object with field definitions including name, type, required status, description, and default values`,
        examples: [
            '// Discover schema before creating\nn8n_manage_credentials({action: "getSchema", type: "httpHeaderAuth"})',
            '// Create an HTTP header auth credential\nn8n_manage_credentials({action: "create", name: "My API Key", type: "httpHeaderAuth", data: {name: "X-API-Key", value: "sk-abc123"}})',
            '// List credentials (first page)\nn8n_manage_credentials({action: "list"})',
            '// Fetch the next page using the previous response\'s nextCursor\nn8n_manage_credentials({action: "list", cursor: "eyJsaW1pdCI6MTAwLCJvZmZzZXQiOjEwMH0="})',
            '// List ALL credentials with the workflows that use each one (full scan, all pages)\nn8n_manage_credentials({action: "list", includeUsage: true})',
            '// Get a specific credential\nn8n_manage_credentials({action: "get", id: "123"})',
            '// Get a credential with the workflows that reference it\nn8n_manage_credentials({action: "get", id: "123", includeUsage: true})',
            '// Update credential data\nn8n_manage_credentials({action: "update", id: "123", data: {value: "new-secret-value"}})',
            '// Rename a credential\nn8n_manage_credentials({action: "update", id: "123", name: "Renamed Credential"})',
            '// Delete a credential\nn8n_manage_credentials({action: "delete", id: "123"})',
            '// Create basic auth credential\nn8n_manage_credentials({action: "create", name: "Service Auth", type: "httpBasicAuth", data: {user: "admin", password: "secret"}})',
        ],
        useCases: [
            'Provisioning credentials for new workflow integrations',
            'Rotating API keys and secrets on a schedule',
            'Remediating security findings from n8n_audit_instance',
            'Discovering available credential types and their required fields',
            'Bulk credential management across n8n instances',
            'Replacing hardcoded secrets with proper credential references',
        ],
        performance: 'Fast response expected: single HTTP API call per action, typically <200ms.',
        bestPractices: [
            'Always call getSchema before create to discover required fields and their formats',
            'Use descriptive names that identify the service and purpose (e.g., "Slack - Production Bot")',
            'Rotate credentials regularly by updating data fields',
            'After creating credentials, reference them in workflows instead of hardcoding secrets',
            'Use n8n_audit_instance to find credentials that need rotation or cleanup',
            'Verify credential validity by testing the workflow after creation',
        ],
        pitfalls: [
            'delete is permanent and cannot be undone - workflows using the credential will break',
            'Credential type must match exactly (case-sensitive) - use getSchema to verify',
            'OAuth2 credentials may require browser-based authorization flow that cannot be completed via API alone',
            'The list action does not return credential data values for security',
            'Requires N8N_API_URL and N8N_API_KEY to be configured',
            'includeUsage scans all workflows the API exposes (capped at 5000); archived workflows are excluded by n8n. A "no usages" result does not guarantee the credential is unused.',
        ],
        relatedTools: ['n8n_audit_instance', 'n8n_create_workflow', 'n8n_update_partial_workflow', 'n8n_health_check'],
    }
};
//# sourceMappingURL=n8n-manage-credentials.js.map