Skip to main content

MCP server for Odoo ERP — connect any AI agent to your Odoo instance

Project description

Odoo MCP Server

An MCP (Model Context Protocol) server that connects AI agents to Odoo ERP instances. Works with Claude Code, Cursor, Windsurf, and any MCP-compatible client.

Supports Odoo 17-18 (JSON-RPC) and Odoo 19+ (JSON-2 API) — auto-detects the best protocol.

Quick Start

# Run directly (uv handles dependencies automatically)
ODOO_URL=https://my.odoo.com ODOO_DB=mydb ODOO_USER=admin ODOO_PASSWORD=secret \
  uv run odoo_mcp_server.py

No virtualenv or pip install needed — the script has inline metadata that uv resolves automatically.

Configure in Claude Code

Add to your project's .mcp.json:

{
  "mcpServers": {
    "odoo": {
      "type": "stdio",
      "command": "uv",
      "args": ["run", "--python", "3.11", "--script", "/path/to/odoo_mcp_server.py"],
      "env": {
        "ODOO_URL": "https://your-instance.odoo.com",
        "ODOO_DB": "your-database",
        "ODOO_USER": "admin",
        "ODOO_PASSWORD": "your-password"
      }
    }
  }
}

Or for Odoo 19+ with API key auth:

{
  "mcpServers": {
    "odoo": {
      "type": "stdio",
      "command": "uv",
      "args": ["run", "--python", "3.11", "--script", "/path/to/odoo_mcp_server.py"],
      "env": {
        "ODOO_URL": "https://your-instance.odoo.com",
        "ODOO_DB": "your-database",
        "ODOO_USER": "admin",
        "ODOO_API_KEY": "your-api-key"
      }
    }
  }
}

Configure in Cursor / Windsurf

Add to ~/.cursor/mcp.json or equivalent:

{
  "mcpServers": {
    "odoo": {
      "command": "uv",
      "args": ["run", "--python", "3.11", "--script", "/path/to/odoo_mcp_server.py"],
      "env": {
        "ODOO_URL": "https://your-instance.odoo.com",
        "ODOO_DB": "your-database",
        "ODOO_USER": "admin",
        "ODOO_PASSWORD": "your-password"
      }
    }
  }
}

Environment Variables

Variable Required Description
ODOO_URL Yes Odoo instance URL
ODOO_DB Yes Database name
ODOO_USER Yes Login username
ODOO_PASSWORD One of these Password (Odoo 17-18)
ODOO_API_KEY required API key (Odoo 19+, preferred)
ODOO_READONLY No Set to true to disable all write operations

Read-Only Mode

Set ODOO_READONLY=true to disable create, update, delete, and execute tools. Useful for safe browsing of production instances:

{
  "mcpServers": {
    "odoo": {
      "type": "stdio",
      "command": "uv",
      "args": ["run", "--python", "3.11", "--script", "/path/to/odoo_mcp_server.py"],
      "env": {
        "ODOO_URL": "https://production.odoo.com",
        "ODOO_DB": "prod",
        "ODOO_USER": "readonly-user",
        "ODOO_PASSWORD": "secret",
        "ODOO_READONLY": "true"
      }
    }
  }
}

Available Tools

Core CRUD

Tool Description
odoo_search_read Query records with domain filters, field selection, pagination
odoo_search_count Count matching records without fetching data
odoo_export Bulk export up to 2000 records per call for spreadsheets
odoo_create Create new records
odoo_update Update existing records by ID
odoo_delete Delete records by ID
odoo_execute Run any model method (action_confirm, action_post, etc.)

Discovery

Tool Description
odoo_list_models Discover available models with keyword filter
odoo_get_fields Inspect field definitions for any model
odoo_doctor Health diagnostics (version, modules, users, crons, errors)
odoo_connection_info Show current connection details

Model Customization

Tool Description
odoo_model_info Get comprehensive model metadata in one call — fields, views, actions, defaults, sort order
odoo_set_default Set, update, or clear a field's default value (handles ir.default + JSON encoding)
odoo_get_view Get the fully rendered (merged) form/tree/search view XML
odoo_modify_action Change a window action's domain, context, sort order, limit, or view modes

Example Usage

Once configured, ask your AI agent:

  • "List all sale orders from this month"
  • "Show me the fields on res.partner"
  • "Create a new contact named Acme Corp"
  • "Run a health check on the Odoo instance"
  • "Export all products to a spreadsheet"
  • "Confirm sale order 42"

Model Customization Examples

  • "What's the default sort order for sale.order?"
  • "Change the default invoice policy on products to 'delivery'"
  • "Show me the form view for res.partner"
  • "What window actions exist for account.move? Change the default sort to date desc"
  • "List all custom fields on res.partner"
  • "What fields are required on sale.order?"

Model Customization Tools — Detailed Reference

odoo_model_info

Returns everything about a model in one call, eliminating the need for multiple exploratory queries.

odoo_model_info(model="sale.order")

Returns:

  • default_order — the model's _order attribute (e.g. "date_order desc, id desc")
  • rec_name — the field used for display name in dropdowns
  • field_count — total number of fields
  • fields_by_type — field count grouped by type (many2one: 12, char: 8, ...)
  • custom_fields — user-created fields (x_ prefix or state=manual)
  • relational_fields — all Many2one, One2many, Many2many with their targets
  • required_fields — fields that must be filled
  • views — base views (form, tree, search) with IDs and priorities
  • actions — window actions with their domain, context, and view modes
  • defaults — current ir.default values set for this model's fields

odoo_set_default

Manages field defaults via ir.default with proper JSON encoding. The most common source of agent errors when done manually.

# Set global default
odoo_set_default(model="product.template", field_name="invoice_policy", value="delivery")

# Set user-specific default
odoo_set_default(model="sale.order", field_name="warehouse_id", value=2, user_id=5)

# Remove a default
odoo_set_default(model="product.template", field_name="invoice_policy", value=null)

The tool:

  1. Finds the field_id in ir.model.fields (validates the field exists)
  2. JSON-encodes the value automatically
  3. Creates or updates the ir.default record
  4. Returns before/after values for confirmation

odoo_get_view

Returns the fully rendered view XML after all inheritance is applied — what the user actually sees, not the raw fragments stored in ir.ui.view.

odoo_get_view(model="sale.order", view_type="form")
odoo_get_view(model="res.partner", view_type="tree")
odoo_get_view(model="account.move", view_type="search")

Returns:

  • arch — the complete merged XML
  • view_id — the base view ID
  • fields_in_view — list of field names present in the view

odoo_modify_action

Changes how a model appears in the UI by modifying its window action (ir.actions.act_window).

# List actions for a model (read-only)
odoo_modify_action(model="sale.order")

# Change default sort order
odoo_modify_action(action_id=42, order="date_order desc")

# Change default filter and page size
odoo_modify_action(action_id=42, domain="[['state','=','sale']]", limit=200)

# Add default grouping via context
odoo_modify_action(action_id=42, context="{'group_by': 'partner_id'}")

The tool returns before/after values so you can verify what changed.

How It Works

AI Agent (Claude, Cursor, etc.)
    ↕ MCP Protocol (stdio)
Odoo MCP Server
    ↕ JSON-RPC / JSON-2 API
Odoo Instance

The server authenticates once at startup and maintains a persistent connection. All tools use the same authenticated session.

Requirements

  • Python 3.11+
  • uv (recommended) or pip install fastmcp httpx

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

odoo_simple_mcp-0.1.0.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

odoo_simple_mcp-0.1.0-py3-none-any.whl (14.2 kB view details)

Uploaded Python 3

File details

Details for the file odoo_simple_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: odoo_simple_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for odoo_simple_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7c71aa44e9da69f88f0d9912701be6ef8af1e4831d1fc8c4ebf25a9f3bf38438
MD5 29395fbaabad5dbdcae7a276aa3b15e4
BLAKE2b-256 9a885c16c8e53d3c125b8cea2947e4395a326ee351a063ebebefd249a37bbe3b

See more details on using hashes here.

Provenance

The following attestation bundles were made for odoo_simple_mcp-0.1.0.tar.gz:

Publisher: publish.yml on oconsole/odoo-mcp-server

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file odoo_simple_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for odoo_simple_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5f2b01e9f78dd7700e642193295e313a4c6c5e673db5936f8bf882de962d5526
MD5 e0b19cdbd7f6e86ff4b19cd5919a6d1f
BLAKE2b-256 86cdb7c084b9baada9cb456ccef7ed9d620daadd8170d9c321d68afcf70dd128

See more details on using hashes here.

Provenance

The following attestation bundles were made for odoo_simple_mcp-0.1.0-py3-none-any.whl:

Publisher: publish.yml on oconsole/odoo-mcp-server

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page