Getting Started
Connect your AI assistant to Ferrule in minutes.
Getting Started
Connect your AI assistant to Ferrule to access 1,000+ API methods across 17 integrations.
You'll need a Ferrule account and at least one integration connected. Sign in to the Ferrule dashboard to get started, then choose your AI client below.
Claude Setup
claude_desktop_config.json. Use the Connectors UI in Claude.ai settings instead.- Open Claude.ai in your browser
- Go to Settings → Connectors
- Click Add connector
- Enter the Ferrule MCP URL:
https://app.ferrule.io/api/mcp- Complete OAuth authorization in the browser popup
- Verify the connection — Ferrule's tools should appear in Claude's tools panel
After connecting, ask Claude: "What Ferrule tools do you have access to?" You should see a list of tools from your connected integrations.
API Key Authentication
API Key setup (alternative to OAuth)
API key authentication may be discontinued in a future release. For new integrations, use OAuth 2.1 which provides automatic token refresh and improved security. API keys are supported for programmatic and headless access only.
Generating an API Key
- Go to the Ferrule dashboard and navigate to API Keys
- Click Create API Key and set an expiry
- Copy the key immediately — it will not be shown again
Using Your API Key
Pass the API key as a Bearer token in the Authorization header:
Authorization: Bearer <your-api-key>Next Steps
- Understanding MCP Protocol — how Ferrule's dual-protocol gateway works
- OAuth 2.1 Flow — detailed OAuth authorization flow
- Tool Reference — browse all 17 integrations and their tools
- Troubleshooting — fix connection and authentication issues