MCP Server For Odoo

What is MCP Server For Odoo about?

Enables AI assistants to communicate with an Odoo ERP instance via a Model Context Protocol server. The server translates natural‑language requests into Odoo RPC calls, handling authentication, permissions, and formatting the responses for LLM consumption.

How to use MCP Server For Odoo?

Install the runtime – install UV (recommended) or use pip/pipx.
Add the Odoo MCP module to your Odoo server (version 17+).
Set required environment variables (ODOO_URL, ODOO_API_KEY or ODOO_USER/ODOO_PASSWORD, optional ODOO_DB).
Choose a transport – the default stdio works for desktop AI apps; streamable‑http can expose an HTTP endpoint (--host, --port).
Run the server (e.g., uvx mcp-server-odoo or python -m mcp_server_odoo).
Reference the server in your AI tool by adding the configuration to the tool’s MCP settings (Claude Desktop, Cursor, VS Code, Zed, etc.).

Key Features

Search and retrieve any Odoo record with flexible domain filters
Create, update, and delete records with field validation
Browse, count, and inspect model fields
Smart pagination for large result sets
Secure authentication via API key or username/password
Multiple transport options (stdio, streamable‑http)
LLM‑optimized hierarchical text output
Permission checks respect Odoo’s native access rights

Use Cases

Ask an AI assistant to list all customers from a specific country
Generate sales reports by counting orders that match a date range
Create new products or partners on the fly from natural language prompts
Update contact information or order status directly through chat
Automate routine ERP tasks (e.g., posting invoices, scheduling events)
Provide real‑time ERP data within code‑generation or debugging sessions

FAQ

Q: Which authentication method should I use? A: API keys are recommended for security and simplicity. Username/password works only if API keys are unavailable.

Q: Do I need to install anything on the Odoo server? A: Only the "mcp_server" module from the Odoo app store is required.

Q: Can I run the server remotely? A: Yes, use the streamable‑http transport and expose the server on a network‑accessible host/port.

Q: What if my Odoo instance restricts database listing? A: Provide the ODOO_DB environment variable; the server will use that database directly.

Q: How do I debug connection problems? A: Enable debug logging with ODOO_MCP_LOG_LEVEL=DEBUG and verify the URL, API key, and network access.

Q: Is SSL verification required? A: HTTPS is mandatory in production. If Python cannot verify certificates, set SSL_CERT_FILE to the path of your system's CA bundle.

An MCP server that enables AI assistants like Claude to interact with Odoo ERP systems. Access business data, search records, create new entries, update existing data, and manage your Odoo instance through natural language.

Features

🔍 Search and retrieve any Odoo record (customers, products, invoices, etc.)
✨ Create new records with field validation and permission checks
✏️ Update existing data with smart field handling
🗑️ Delete records respecting model-level permissions
📊 Browse multiple records and get formatted summaries
🔢 Count records matching specific criteria
📋 Inspect model fields to understand data structure
🔐 Secure access with API key or username/password authentication
🎯 Smart pagination for large datasets
💬 LLM-optimized output with hierarchical text formatting

Installation

Prerequisites

Python 3.10 or higher
Access to an Odoo instance (version 17.0+)
The Odoo MCP module installed on your Odoo server
(optional) An API key generated in Odoo (Settings > Users > API Keys)

Install UV First

The MCP server runs on your local computer (where Claude Desktop is installed), not on your Odoo server. You need to install UV on your local machine:

curl -LsSf https://astral.sh/uv/install.sh | sh

powershell -c "irm https://astral.sh/uv/install.ps1 | iex"

After installation, restart your terminal to ensure UV is in your PATH.

Installing via MCP Settings (Recommended)

Add this configuration to your MCP settings:

{
  "mcpServers": {
    "odoo": {
      "command": "uvx",
      "args": ["mcp-server-odoo"],
      "env": {
        "ODOO_URL": "https://your-odoo-instance.com",
        "ODOO_API_KEY": "your-api-key-here"
      }
    }
  }
}

Add to ~/Library/Application Support/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "odoo": {
      "command": "uvx",
      "args": ["mcp-server-odoo"],
      "env": {
        "ODOO_URL": "https://your-odoo-instance.com",
        "ODOO_API_KEY": "your-api-key-here",
        "ODOO_DB": "your-database-name"
      }
    }
  }
}

Add to ~/.cursor/mcp_settings.json:

{
  "mcpServers": {
    "odoo": {
      "command": "uvx",
      "args": ["mcp-server-odoo"],
      "env": {
        "ODOO_URL": "https://your-odoo-instance.com",
        "ODOO_API_KEY": "your-api-key-here",
        "ODOO_DB": "your-database-name"
      }
    }
  }
}

Add to your VS Code settings (~/.vscode/mcp_settings.json or workspace settings):

{
  "github.copilot.chat.mcpServers": {
    "odoo": {
      "command": "uvx",
      "args": ["mcp-server-odoo"],
      "env": {
        "ODOO_URL": "https://your-odoo-instance.com",
        "ODOO_API_KEY": "your-api-key-here",
        "ODOO_DB": "your-database-name"
      }
    }
  }
}

Add to ~/.config/zed/settings.json:

{
  "context_servers": {
    "odoo": {
      "command": "uvx",
      "args": ["mcp-server-odoo"],
      "env": {
        "ODOO_URL": "https://your-odoo-instance.com",
        "ODOO_API_KEY": "your-api-key-here",
        "ODOO_DB": "your-database-name"
      }
    }
  }
}

Alternative Installation Methods

# Install globally
pip install mcp-server-odoo

# Or use pipx for isolated environment
pipx install mcp-server-odoo

Then use mcp-server-odoo as the command in your MCP configuration.

git clone https://github.com/ivnvxd/mcp-server-odoo.git
cd mcp-server-odoo
pip install -e .

Then use the full path to the package in your MCP configuration.

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`

*Either ODOO_API_KEY or both ODOO_USER and ODOO_PASSWORD are required.

Notes:

If database listing is restricted on your server, you must specify ODOO_DB
API key authentication is recommended for better security

Transport Options

The server supports multiple transport protocols for different use cases:

1. stdio (Default)

Standard input/output transport - used by desktop AI applications like Claude Desktop.

# Default transport - no additional configuration needed
uvx mcp-server-odoo

2. streamable-http

Standard HTTP transport for REST API-style access and remote connectivity.

# Run with HTTP transport
uvx mcp-server-odoo --transport streamable-http --host 0.0.0.0 --port 8000

# Or use environment variables
export ODOO_MCP_TRANSPORT=streamable-http
export ODOO_MCP_HOST=0.0.0.0
export ODOO_MCP_PORT=8000
uvx mcp-server-odoo

The HTTP endpoint will be available at: http://localhost:8000/mcp/

Note: SSE (Server-Sent Events) transport has been deprecated in MCP protocol version 2025-03-26. Use streamable-http transport instead for HTTP-based communication. Requires MCP library v1.9.4 or higher for proper session management.

Transport Configuration

Variable/Flag	Description	Default
`ODOO_MCP_TRANSPORT` / `--transport`	Transport type: stdio, streamable-http	`stdio`
`ODOO_MCP_HOST` / `--host`	Host to bind for HTTP transports	`localhost`
`ODOO_MCP_PORT` / `--port`	Port to bind for HTTP transports	`8000`

{
  "mcpServers": {
    "odoo-remote": {
      "command": "uvx",
      "args": ["mcp-server-odoo", "--transport", "streamable-http", "--port", "8080"],
      "env": {
        "ODOO_URL": "https://your-odoo-instance.com",
        "ODOO_API_KEY": "your-api-key-here",
        "ODOO_DB": "your-database-name"
      }
    }
  }
}

Setting up Odoo

Install the MCP module:
- Download the mcp_server module
- Install it in your Odoo instance
- Navigate to Settings > MCP Server
Enable models for MCP access:
- Go to Settings > MCP Server > Enabled Models
- Add models you want to access (e.g., res.partner, product.product)
- Configure permissions (read, write, create, delete) per model
Generate an API key:
- Go to Settings > Users & Companies > Users
- Select your user
- Under the "API Keys" tab, create a new key
- Copy the key for your MCP configuration

Usage Examples

Once configured, you can ask Claude:

Search & Retrieve:

"Show me all customers from Spain"
"Find products with stock below 10 units"
"List today's sales orders over $1000"
"Search for unpaid invoices from last month"
"Count how many active employees we have"
"Show me the contact information for Microsoft"

Create & Manage:

"Create a new customer contact for Acme Corporation"
"Add a new product called 'Premium Widget' with price $99.99"
"Create a calendar event for tomorrow at 2 PM"
"Update the phone number for customer John Doe to +1-555-0123"
"Change the status of order SO/2024/001 to confirmed"
"Delete the test contact we created earlier"

Available Tools

`search_records`

Search for records in any Odoo model with filters.

{
  "model": "res.partner",
  "domain": [["is_company", "=", true], ["country_id.code", "=", "ES"]],
  "fields": ["name", "email", "phone"],
  "limit": 10
}

Field Selection Options:

Omit fields or set to null: Returns smart selection of common fields
Specify field list: Returns only those specific fields
Use ["__all__"]: Returns all fields (use with caution)

`get_record`

Retrieve a specific record by ID.

{
  "model": "res.partner",
  "record_id": 42,
  "fields": ["name", "email", "street", "city"]
}

Field Selection Options:

Omit fields or set to null: Returns smart selection of common fields with metadata
Specify field list: Returns only those specific fields
Use ["__all__"]: Returns all fields without metadata

`list_models`

List all models enabled for MCP access.

{}

`create_record`

Create a new record in Odoo.

{
  "model": "res.partner",
  "values": {
    "name": "New Customer",
    "email": "customer@example.com",
    "is_company": true
  }
}

`update_record`

Update an existing record.

{
  "model": "res.partner",
  "record_id": 42,
  "values": {
    "phone": "+1234567890",
    "website": "https://example.com"
  }
}

`delete_record`

Delete a record from Odoo.

{
  "model": "res.partner",
  "record_id": 42
}

Resources

The server also provides direct access to Odoo data through resource URIs:

odoo://res.partner/record/1 - Get partner with ID 1
odoo://product.product/search?domain=[["qty_available",">",0]] - Search products in stock
odoo://sale.order/browse?ids=1,2,3 - Browse multiple sales orders
odoo://res.partner/count?domain=[["customer_rank",">",0]] - Count customers
odoo://product.product/fields - List available fields for products

Security

Always use HTTPS in production environments
Keep your API keys secure and rotate them regularly
Configure model access carefully - only enable necessary models
The MCP module respects Odoo's built-in access rights and record rules
Each API key is linked to a specific user with their permissions

Troubleshooting

If you're getting connection errors:

Verify your Odoo URL is correct and accessible
Check that the MCP module is installed: visit https://your-odoo.com/mcp/health
Ensure your firewall allows connections to Odoo

If authentication fails:

Verify your API key is active in Odoo
Check that the user has appropriate permissions
Try regenerating the API key
For username/password auth, ensure 2FA is not enabled

If you can't access certain models:

Go to Settings > MCP Server > Enabled Models in Odoo
Ensure the model is in the list and has appropriate permissions
Check that your user has access to that model in Odoo's security settings

This error means UV is not installed or not in your PATH:

Solution 1: Install UV (see Installation section above)

Solution 2: macOS PATH Issue Claude Desktop on macOS doesn't inherit your shell's PATH. Try:

Quit Claude Desktop completely (Cmd+Q)
Open Terminal
Launch Claude from Terminal:
```
open -a "Claude"
```

Solution 3: Use Full Path Find UV location and use full path:

which uvx
# Example output: /Users/yourname/.local/bin/uvx

Then update your config:

{
  "command": "/Users/yourname/.local/bin/uvx",
  "args": ["mcp-server-odoo"]
}

If you see "Access Denied" when listing databases:

This is normal - some Odoo instances restrict database listing for security
Make sure to specify ODOO_DB in your configuration
The server will use your specified database without validation

Example configuration:

{
  "env": {
    "ODOO_URL": "https://your-odoo.com",
    "ODOO_API_KEY": "your-key",
    "ODOO_DB": "your-database-name"
  }
}

Note: ODOO_DB is required if database listing is restricted on your server.

This error occurs when Python cannot verify SSL certificates, often on macOS or corporate networks.

Solution: Add SSL certificate path to your environment configuration:

{
  "env": {
    "ODOO_URL": "https://your-odoo.com",
    "ODOO_API_KEY": "your-key",
    "SSL_CERT_FILE": "/etc/ssl/cert.pem"
  }
}

This tells Python where to find the system's SSL certificate bundle for HTTPS connections. The path /etc/ssl/cert.pem is the standard location on most systems.

Enable debug logging for more information:

{
  "env": {
    "ODOO_URL": "https://your-odoo.com",
    "ODOO_API_KEY": "your-key",
    "ODOO_MCP_LOG_LEVEL": "DEBUG"
  }
}

Development

# Clone the repository
git clone https://github.com/ivnvxd/mcp-server-odoo.git
cd mcp-server-odoo

# Install in development mode
pip install -e ".[dev]"

# Run tests
pytest --cov

# Run the server
python -m mcp_server_odoo

# Using uvx
npx @modelcontextprotocol/inspector uvx mcp-server-odoo

# Using local installation
npx @modelcontextprotocol/inspector python -m mcp_server_odoo

Testing

Transport Tests

You can test both stdio and streamable-http transports to ensure they're working correctly:

# Run comprehensive transport tests
python tests/run_transport_tests.py

This will test:

stdio transport: Basic initialization and communication
streamable-http transport: HTTP endpoint, session management, and tool calls

Unit Tests

For complete testing including unit and integration tests:

# Run all tests
uv run pytest --cov

# Run specific test categories
uv run pytest tests/test_tools.py -v
uv run pytest tests/test_server_foundation.py -v

License

This project is licensed under the Mozilla Public License 2.0 (MPL-2.0) - see the LICENSE file for details.

Contributing

Contributions are very welcome! Please see the CONTRIBUTING guide for details.

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 do not forget to give the project a star if you like it! :star:

MCP Server For Odoo