MCP Odoo Bridge Server
Licensed under the Apache License, Version 2.0 - See LICENSE for details.
A Model Context Protocol (MCP) server that enables AI assistants like Claude to interact with Odoo data using natural language.
๐ฏ What is MCP?
The Model Context Protocol is an open standard by Anthropic that enables AI assistants to securely connect to external data sources. This server acts as a bridge between Claude (or other MCP clients) and your Odoo instance.
Learn more: MCP Documentation
โจ Features
| Feature | Description |
|---|---|
| ๐ Search Records | Find records using natural language or Odoo domain syntax |
| ๐ Read Records | Get detailed record information by ID |
| ๐ Count Records | Get counts matching criteria |
| โ Create Records | Create new records (with permission) |
| โ๏ธ Update Records | Modify existing records (with permission) |
| ๐๏ธ Delete Records | Remove records (with permission) |
| ๐ List Models | Discover available models |
| ๐ง Get Fields | Understand model structure |
| โก Execute Methods | Run custom methods (if enabled) |
| ๐ API Key Auth | Secure authentication via API keys |
| ๐ Audit Logging | All operations logged for compliance |
๐ Prerequisites
- Odoo instance (17.0, 18.0, or 19.0 recommended)
- Python 3.10+ installed
- AD Odoo MCP Bridge module installed in Odoo (see Odoo Module)
๐ Installation
1. Clone the Repository
git clone https://github.com/yourusername/ad-mcp-bridge-server.git
cd ad-mcp-bridge-server
2. Install Dependencies
pip install -e .
Or with uv:
uv pip install -e .
3. Install the Odoo Module
Install the ad_odoo_mcp_bridge module in your Odoo instance:
- Add the module folder to your Odoo addons path
- Go to Apps โ Install "AD Odoo MCP Bridge"
โ๏ธ Configuration
Environment Variables
The server requires the following environment variables:
| Variable | Required | Description | Example |
|---|---|---|---|
ODOO_URL |
Yes | Your Odoo instance URL | https://mycompany.odoo.com |
ODOO_API_KEY |
Yes* | API key for authentication | 0ef5b399e9ee9c11b053dfb6eeba8de473c29fcd |
ODOO_USER |
Yes* | Username (if not using API key) | admin |
ODOO_PASSWORD |
Yes* | Password (if not using API key) | admin |
ODOO_DB |
No | Database name (auto-detected if not set) | mycompany |
ODOO_MAX_RECORDS |
No | Default max records per query (default: 100) |
200 |
ODOO_TIMEOUT |
No | Request timeout in seconds (default: 30) |
60 |
ODOO_YOLO |
No | YOLO mode - bypasses MCP security (โ ๏ธ DEV ONLY) | off, read, true |
* Authentication: You must provide either
ODOO_API_KEYor bothODOO_USERandODOO_PASSWORD.
MCP Transport Options
| Variable | Required | Description | Example |
|---|---|---|---|
MCP_TRANSPORT |
No | Transport type: stdio or streamable-http (default: stdio) |
streamable-http |
MCP_HOST |
No | Host for HTTP transport (default: localhost) |
0.0.0.0 |
MCP_PORT |
No | Port for HTTP transport (default: 8000) |
8080 |
YOLO Mode Values
| Value | Description |
|---|---|
off |
All operations require explicit MCP Bridge permissions (default) |
read |
Allows read-only operations on all models without configuration |
true |
โ ๏ธ DANGEROUS - Allows all operations including write/delete without restrictions |
โ ๏ธ Warning: YOLO mode bypasses security checks and should NEVER be used in production. It's intended only for local development and testing.
Create a .env File (Optional)
ODOO_URL=https://mycompany.odoo.com
ODOO_DB=mycompany
ODOO_API_KEY=your-api-key-here
๐ Usage with Claude Desktop
Step 1: Generate API Key in Odoo
- Go to MCP Bridge โ Configuration โ API Keys
- Click Create โ Select user โ Generate Key
- Copy the key (shown only once!)
Step 2: Configure Claude Desktop
Edit claude_desktop_config.json:
Windows: %APPDATA%\Claude\claude_desktop_config.json macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
{
"mcpServers": {
"odoo": {
"command": "python",
"args": ["-m", "ad_mcp_bridge_server"],
"cwd": "/path/to/ad-mcp-bridge-server/src",
"env": {
"ODOO_URL": "http://localhost:8069",
"ODOO_DB": "your_database",
"ODOO_API_KEY": "your-api-key"
}
}
}
}
Windows Note: Use the full Python path if needed:
"command": "C:\\path\\to\\venv\\Scripts\\python.exe"
Step 3: Restart Claude Desktop
Close and reopen Claude Desktop. You should see the ๐ง Tools icon.
Step 4: Start Chatting!
Try these prompts:
- "Show me all customers from the United States"
- "What's the status of order SO/2024/0153?"
- "Create a new lead for ABC Company"
- "How many unpaid invoices do we have?"
๐ Usage with VS Code
Create .vscode/mcp.json in your workspace:
{
"servers": {
"odoo": {
"command": "python",
"args": ["-m", "ad_mcp_bridge_server"],
"cwd": "/path/to/ad-mcp-bridge-server/src",
"env": {
"ODOO_URL": "http://localhost:8069",
"ODOO_DB": "your_database",
"ODOO_API_KEY": "your-api-key"
}
}
}
}
๐งช Testing with MCP Inspector
Use the official MCP debugging tool:
npx @modelcontextprotocol/inspector python -m ad_mcp_bridge_server
This opens a web UI to test all tools interactively.
๐๏ธ Odoo Module
This MCP server requires the AD Odoo MCP Bridge module installed in Odoo.
Compatibility
| Odoo Version | Status |
|---|---|
| 19.0 | โ Fully Supported |
| 18.0 | โ Supported |
| 17.0 | โ Supported |
| 16.0 | โ Supported |
Module Features
- Model Configuration: Choose which models AI can access
- Permission Control: Set read/create/update/delete per model
- API Key Management: Generate and manage API keys
- Audit Logging: Track all AI operations
- Rate Limiting: Control request frequency
- YOLO Mode: Quick access mode for development
Module Installation
- Copy
ad_odoo_mcp_bridgefolder to your Odoo addons path - Restart Odoo
- Go to Apps โ Remove "Apps" filter โ Search "MCP" โ Install
๐ Security
- API Key Authentication: All requests require a valid API key
- Permission Inheritance: AI inherits Odoo user's permissions
- Audit Trail: All operations logged with IP, timestamp, and details
- Rate Limiting: Configurable per-key request limits
- Field Exclusions: Sensitive fields can be blocked
๐ API Endpoints (Odoo Module)
The Odoo module exposes these JSON-RPC endpoints:
| Endpoint | Description |
|---|---|
GET /mcp/health |
Health check |
POST /mcp/info |
Server information |
POST /mcp/models |
List enabled models |
POST /mcp/fields |
Get model fields |
POST /mcp/search |
Search records |
POST /mcp/read |
Read record by ID |
POST /mcp/count |
Count records |
POST /mcp/create |
Create record |
POST /mcp/write |
Update record |
POST /mcp/unlink |
Delete record |
POST /mcp/execute |
Execute method |
๐ ๏ธ Development
Run Locally
cd src
export ODOO_URL=http://localhost:8069
export ODOO_DB=mydb
export ODOO_API_KEY=your-key
python -m ad_mcp_bridge_server
Project Structure
ad-mcp-bridge-server/
โโโ src/
โ โโโ ad_mcp_bridge_server/
โ โโโ __init__.py
โ โโโ __main__.py # Entry point
โ โโโ config.py # Pydantic settings
โ โโโ odoo_client.py # Odoo HTTP client
โ โโโ server.py # MCP server & tools
โโโ pyproject.toml
โโโ README.md
โโโ .env.example
๐ MCP Resources
๐ค Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
โ Support
Thank you for using this project! If you find it helpful and would like to support my work, kindly consider buying me a coffee. Your support is greatly appreciated!
And don't forget to give the project a โญ star if you like it!
๐ License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
๐ Acknowledgments
๐ About
A Model Context Protocol (MCP) server that enables AI assistants to securely interact with Odoo ERP systems through standardized resources and tools for data retrieval and manipulation.
Made with โค๏ธ for the Odoo and AI community