Skip to main content

​
Prerequisites

Before you begin, ensure you have:

Well Account

Active workspace with data at app.wellapp.ai

API Key or OAuth

From Settings > API Keys

MCP Client

Claude, Cursor, Windsurf, or ChatGPT

Node.js 18+

Required for local/stdio transport only
Most clients support adding custom MCP servers directly. Just add: 
https://api.wellapp.ai/v1/mcp
Then authenticate with your Well account. Done! → See detailed steps per client

​
Option B: Config File

For manual setup or automation, use an API key:
  1. Log into Well Dashboard
  2. Go to Settings > API Keys
  3. Click Generate New Key
  4. Copy the key and add it to your client’s config file
→ See config examples per client

​
Test the Connection

Once configured, try these prompts: 
Show me my invoices

What companies do I have in Well?

Find all unpaid invoices over 1000 EUR
If you see your data, you’re all set!

​
Troubleshooting

  1. Verify your API key is correct
  2. Restart your AI client completely
  3. Check the config file syntax (valid JSON)
  1. Ensure your workspace has data
  2. Check that your API key has access to the workspace
  1. Regenerate your API key
  2. Check for extra spaces or characters in the key

​
Next Steps

Authentication

Learn about API Key vs OAuth

Available Tools

See all available MCP tools