Odoo MCP Server
The Odoo MCP Server connects any Odoo 16+ instance to AI agents via the Model Context Protocol — no Odoo-side setup required — providing read, write, diagnostic, migration, and audit capabilities.
Read & Discovery
list_models– List all model technical names and labelsget_model_fields– Retrieve field metadata for any modelsearch_records/read_record– Bounded, read-only searches and single-record readsaggregate_records– Server-side groupby/sum/count/avg aggregationssearch_employee/search_holidays– Search employees or leave recordsget_odoo_profile– Server version, user context, transport, and installed modulesschema_catalog– Build a bounded model catalog with optional field metadatabuild_domain– Build and validate Odoo domains from structured conditions
Safe Write Workflow
preview_write– Preview acreate,write, orunlinkwithout executing itvalidate_write– Validate a write payload against livefields_getmetadataexecute_approved_write– Execute a token-approved write (requiresODOO_MCP_ENABLE_WRITES=1)execute_method– Execute custom model methods (allowlist or broad-mode gated)chatter_post– Post chatter messages on anymail.threadrecord
Diagnostics
diagnose_odoo_call– Diagnose a model call without executing itdiagnose_access– Analyze ACL and record-rule visibility for the current userinspect_model_relationships– Inspect relationship fields, required fields, and write hints
Migration Helpers
generate_json2_payload– Convert XML-RPC-style calls into JSON-2 request previews (Odoo 19+)upgrade_risk_report– Surface transport, method, and migration risks across Odoo versions
Audit & Planning
scan_addons_source– Scan local addon source code without importing itfit_gap_report– Classify requirements into fit/gap implementation bucketsbusiness_pack_report– Report expected modules, models, and discovery calls for sales, CRM, inventory, accounting, or HR
Utility & Infrastructure
health_check– Report the server's runtime safety postureSupports XML-RPC (Odoo 16–19) and External JSON-2 (Odoo 19+) transports
Streamable HTTP/SSE transport for non-stdio clients
5 reusable agent prompts (diagnostics, fit/gap, JSON-2 migration, safe writes, module audits)
4 resource URIs for browsing models, fields, and records
DNS-rebinding protection and host/origin allowlists for HTTP deployments
Provides comprehensive access to Odoo ERP systems, allowing interaction with Odoo models, records, and methods. Enables searching, reading, creating, updating, and deleting records, as well as executing custom methods on any Odoo model.
Implements XML-RPC communication for secure connections to Odoo instances, enabling the transmission of data between the MCP server and Odoo systems.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@Odoo MCP Serversearch for employees named John"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
Odoo MCP
Odoo MCP turns any Odoo 16+ database into a Model Context Protocol server — using only your existing credentials. No App Store module, no permission setup, no admin access required. Built for local agents, IDEs, and automation tools that need real Odoo context without hand-rolled scripts or unsafe direct write access.
It speaks XML-RPC for Odoo 16-18 and External JSON-2 for Odoo 19+. It exposes a compact MCP surface with read tools, diagnostics, schema discovery, migration helpers, local addon scanning, and a gated write workflow.
Try it in 30 seconds
Once configured (see Install and Configure), ask your agent things like:
"Show me all customers from Spain with unpaid invoices."
"Find products with stock below 10 units in the main warehouse."
"Audit the
custom_billingaddon for upgrade risks before we move to Odoo 19."
Related MCP server: Odoo MCP Server
Highlights
Capability | What it gives you |
24 MCP tools | Read records, aggregate server-side, post chatter, inspect schema, build domains, scan addons, diagnose calls, access rules, and validate writes. |
5 agent prompts | Reusable workflows for failed calls, fit/gap workshops, JSON-2 migration, safe writes, and module audits. |
Odoo 16-19 coverage | XML-RPC by default, JSON-2 opt-in for Odoo 19. |
Streamable HTTP | Local HTTP/SSE support for clients that do not use stdio. |
Smart field selection |
|
Server-side aggregation |
|
Chatter integration |
|
Locale plumbing |
|
Structured logging | JSON formatter and rotating file handler via |
Safe writes | Direct |
Real smoke tests | Docker Compose validation boots disposable Odoo 16.0, 17.0, 18.0, and 19.0 stacks, including restricted users, custom record rules, and packaged addon XML install/update. |
Why Odoo MCP
Trait | Odoo MCP | Other MCP-Odoo bridges |
Setup steps on Odoo side | 0 — works with any Odoo 16+ instance using credentials you already have. | Often require installing an App Store module, configuring enabled models, and granting per-tool permissions. |
Safe write workflow | Approval token + live | Often expose direct |
Diagnostics |
| Usually CRUD only. |
Transport | XML-RPC (16-19) and External JSON-2 (Odoo 19+). Ready for Odoo 20. | Usually XML-RPC only — XML-RPC is deprecated in Odoo 20. |
Migration helpers |
| None. |
Agent prompts | 5 ready-made prompts for diagnose / fit-gap / JSON-2 migration / safe-write / module-audit. | Usually none. |
HTTP transport security | DNS-rebinding protection, host/origin allowlists, local-bind by default. | Often missing. |
Real Odoo smoke tests | Docker Compose harness boots disposable Odoo 16/17/18/19 stacks per release. | Often mock-based only. |
Install
The fastest path is uvx, which fetches the package on demand:
uvx odoo-mcp --healthOr install into your environment:
pip install odoo-mcp
# or: pipx install odoo-mcpPull the prebuilt container from GitHub Container Registry:
docker pull ghcr.io/tuanle96/mcp-odoo:latestFor local development:
git clone https://github.com/tuanle96/mcp-odoo.git
cd mcp-odoo
uv sync --extra devConfigure
Set connection values in the environment:
export ODOO_URL="https://your-odoo-instance.com"
export ODOO_DB="your-database"
export ODOO_USERNAME="your-user"
export ODOO_PASSWORD="your-password-or-api-key"
export ODOO_TRANSPORT="xmlrpc"For Odoo 19 JSON-2:
export ODOO_TRANSPORT="json2"
export ODOO_API_KEY="your-odoo-api-key"
export ODOO_JSON2_DATABASE_HEADER="1"ODOO_JSON2_DATABASE_HEADER=1 sends X-Odoo-Database on JSON-2 calls. Set it to 0 only when host or dbfilter routing already selects the intended database.
Optional environment variables:
Variable | Default | Effect |
| unset | Inject |
|
| Cap for smart-field selection when caller omits |
|
| Process logger level (DEBUG/INFO/WARNING/ERROR/CRITICAL). |
|
| Truthy → emit JSON-formatted log lines. |
| unset | Path → enable rotating file handler (10MB × 3 backups). |
|
| Required for |
| empty | Exact |
|
| Broad mode for |
|
| Truthy → |
|
| Truthy → permit non-local HTTP binds (still requires external auth/TLS). |
| local | CSV allowlists for HTTP transports. |
You can also use odoo_config.json:
{
"url": "https://your-odoo-instance.com",
"db": "your-database",
"username": "your-user",
"password": "your-password-or-api-key"
}Run
Start the MCP server over stdio:
odoo-mcpor:
python -m odoo_mcpStart Streamable HTTP for local clients:
odoo-mcp --transport streamable-http --host 127.0.0.1 --port 8000 --path /mcpNon-local HTTP binds are rejected unless you pass --allow-remote-http or set MCP_ALLOW_REMOTE_HTTP=1. This server does not include built-in HTTP authentication. Put remote HTTP deployments behind your own authentication, TLS, and network policy.
Check runtime posture without starting the server loop:
odoo-mcp --healthMCP Tools
24 tools grouped by use case. Each tool name is a single-purpose handle the agent can call.
Read & Discover (10)
Tool | Purpose |
| List Odoo model technical names and labels. |
| Read field metadata for one model. |
| Run bounded read-only |
| Read one record by model and ID. Smart-field selection when caller omits |
| Server-side groupby/aggregation via |
| Search employees by name. |
| Search leave records by date range. |
| Read server version, user context, transport, database, and installed module summary. |
| Build a bounded model catalog with optional field metadata. |
| Build and validate an Odoo domain from structured conditions. |
Write & Operate (5)
Tool | Purpose |
| Produce a non-executing approval payload for |
| Validate a write payload against trusted live |
| Execute only a same-session, live-validated, confirmed write when |
| Execute a reviewed model method. Direct |
| Post a chatter message on a |
Diagnose (3)
Tool | Purpose |
| Diagnose a model call without executing it. |
| Diagnose ACL and record-rule visibility for the current Odoo credential. |
| Group relationship fields, required fields, and create/write hints. |
Migrate (2)
Tool | Purpose |
| Convert XML-RPC-shaped input into JSON-2 endpoint, headers, and named body. |
| Surface transport, method, and migration risks across Odoo versions. |
Audit & Plan (3)
Tool | Purpose |
| Scan local addon source without importing addon code. |
| Classify requirements into standard, configuration, Studio, custom module, avoid, or unknown. |
| Report expected modules, models, and discovery calls for sales, CRM, inventory, accounting, or HR. |
Utility (1)
Tool | Purpose |
| Report non-secret MCP runtime posture. |
Resources
URI | Description |
| List available models. |
| Read model metadata and fields. |
| Read one record. |
| Search records with a bounded domain. |
Prompts
Prompt | Use it for |
| Root-cause a failing Odoo call before retrying. |
| Turn raw requirements into Odoo fit/gap buckets. |
| Plan XML-RPC or JSON-RPC migration to External JSON-2. |
| Review a proposed |
| Audit local addon source with scan, risk, and business evidence. |
Safe Write Model
Writes are intentionally boring.
preview_writecreates a canonical, non-executing payload.validate_writechecks model metadata, required fields, readonly fields, relation hints, record IDs, and payload shape.execute_approved_writeruns only when all gates pass:the approval came from
validate_writein the same server process,validation used trusted, non-empty live Odoo
fields_getmetadata,the token has not expired or been consumed,
confirm=trueis passed,ODOO_MCP_ENABLE_WRITES=1is set.
Odoo access rules, record rules, and server-side constraints still decide the final result.
Reviewed side-effect methods such as sale.order.action_confirm can be enabled
one by one:
export ODOO_MCP_ALLOWED_SIDE_EFFECT_METHODS="sale.order.action_confirm,res.partner.message_post"ODOO_MCP_ALLOW_UNKNOWN_METHODS=1 is still supported for trusted deployments,
but health_check reports it as broad mode. Prefer exact allowlist entries when
you only need a small number of reviewed methods.
Client Setup
Claude Desktop on macOS reads MCP configuration from:
~/Library/Application Support/Claude/claude_desktop_config.jsonUse an absolute Python path because GUI apps may not inherit your shell PATH:
{
"mcpServers": {
"odoo": {
"command": "/opt/homebrew/bin/python3",
"args": ["-m", "odoo_mcp"],
"env": {
"ODOO_URL": "https://your-odoo-instance.com",
"ODOO_DB": "your-database",
"ODOO_USERNAME": "your-user",
"ODOO_PASSWORD": "your-password-or-api-key",
"ODOO_TRANSPORT": "xmlrpc"
}
}
}
}More examples are in docs/client-configs.md.
Docker
Use the prebuilt GHCR image:
docker pull ghcr.io/tuanle96/mcp-odoo:latestOr build it locally:
docker build -t mcp/odoo:latest -f Dockerfile .Run over stdio from an MCP client (replace mcp/odoo:latest with ghcr.io/tuanle96/mcp-odoo:latest to use the prebuilt image):
{
"mcpServers": {
"odoo": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e", "ODOO_URL",
"-e", "ODOO_DB",
"-e", "ODOO_USERNAME",
"-e", "ODOO_PASSWORD",
"-e", "ODOO_TRANSPORT",
"-e", "ODOO_API_KEY",
"mcp/odoo:latest"
]
}
}
}Run Streamable HTTP locally:
docker run --rm \
-p 127.0.0.1:8000:8000 \
-e ODOO_URL \
-e ODOO_DB \
-e ODOO_USERNAME \
-e ODOO_PASSWORD \
-e ODOO_TRANSPORT \
-e ODOO_API_KEY \
mcp/odoo:latest \
--transport streamable-http \
--host 0.0.0.0 \
--port 8000 \
--allow-remote-httpTest
Run the normal quality gates:
uv run python -m ruff check .
uv run python -m mypy src
uv run python -m pytestRun real Odoo smoke tests:
uv run --python 3.12 --with-editable . scripts/odoo_compose_smoke.py \
--versions 16.0 17.0 18.0 19.0 \
--timeout 360 \
--inspector-smokeThe smoke harness boots disposable Docker Compose stacks, validates direct Odoo access, validates MCP stdio, and for Odoo 19 also validates JSON-2 and Streamable HTTP.
Compatibility
XML-RPC remains the default transport for broad compatibility. Odoo 19 supports External JSON-2 through ODOO_TRANSPORT=json2. Odoo has documented XML-RPC and JSON-RPC deprecation for Odoo 20, so new integrations should plan for JSON-2.
Contributing
Issues, pull requests, and compatibility reports are welcome. Start with CONTRIBUTING.md, include your Odoo version, transport, client type, and the verification you ran.
Security
Do not publish logs that contain Odoo credentials, API keys, database names from private environments, or full Odoo debug traces. Report vulnerabilities through SECURITY.md.
License
MIT. See LICENSE.
Maintenance
Latest Blog Posts
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/tuanle96/mcp-odoo'
If you have feedback or need assistance with the MCP directory API, please join our Discord server