Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
121 changes: 121 additions & 0 deletions ai_oca_mcp/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
.. image:: https://odoo-community.org/readme-banner-image
:target: https://odoo-community.org/get-involved?utm_source=readme
:alt: Odoo Community Association

==========
Ai Oca Mcp
==========

..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:77c677f59d0b6ca70acba28eabf1fd8140521f9c15b7093e7f3fe2a7c173ad32
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!

.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/license-AGPL--3-blue.png
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
:alt: License: AGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fai-lightgray.png?logo=github
:target: https://github.com/OCA/ai/tree/16.0/ai_oca_mcp
:alt: OCA/ai
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/ai-16-0/ai-16-0-ai_oca_mcp
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/ai&target_branch=16.0
:alt: Try me on Runboat

|badge1| |badge2| |badge3| |badge4| |badge5|

This module exposes Odoo AI tools as an MCP (Model Context Protocol)
server, allowing external AI clients such as n8n or custom agents to
call Odoo functions via the standardized MCP protocol. Authentication is
handled via per-client API keys.

Note: Claude Desktop requires OAuth 2.0, which is not supported directly
by this module. An extension could be required.

**Table of contents**

.. contents::
:local:

Usage
=====

- Access in Developer mode
- Go to ``AI > MCP Server``
- Create a new MCP Server and add the ``generic`` tools you want to
expose
- Click **Add Key** to generate a new API key for a client — the key is
only shown once
- Use the provided URL and the generated key to configure your AI client

Connecting from n8n
-------------------

Use the MCP node with:

- **URL**: the value shown in the ``URL`` field
- **Authentication**: Bearer Token
- **Token**: the generated API key

Tool limitations
----------------

Only tools of kind ``generic`` are supported. Tools requiring a record
context (``generic_model``, ``record``) cannot be used via MCP.

Security
--------

Each client should have its own API key. Keys can be expired
individually from the server form or from ``AI > MCP Server Log`` to
audit all calls.

Bug Tracker
===========

Bugs are tracked on `GitHub Issues <https://github.com/OCA/ai/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <https://github.com/OCA/ai/issues/new?body=module:%20ai_oca_mcp%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.

Do not contact contributors directly about support or help with technical issues.

Credits
=======

Authors
-------

* Dixmit

Contributors
------------

- `Dixmit <https://www.dixmit.com>`__

- Enric Tobella

Maintainers
-----------

This module is maintained by the OCA.

.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org

OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.

This module is part of the `OCA/ai <https://github.com/OCA/ai/tree/16.0/ai_oca_mcp>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
3 changes: 3 additions & 0 deletions ai_oca_mcp/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
from . import controllers
from . import models
from . import wizards
22 changes: 22 additions & 0 deletions ai_oca_mcp/__manifest__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Copyright 2026 Dixmit
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

{
"name": "Ai Oca Mcp",
"summary": """MCP Interface for Odoo""",
"version": "16.0.1.0.0",
"license": "AGPL-3",
"author": "Dixmit,Odoo Community Association (OCA)",
"website": "https://github.com/OCA/ai",
"depends": [
"ai_tool",
],
"data": [
"views/mcp_server_log.xml",
"security/ir.model.access.csv",
"views/mcp_server_key.xml",
"wizards/mcp_server_key_add.xml",
"views/mcp_server.xml",
],
"demo": [],
}
1 change: 1 addition & 0 deletions ai_oca_mcp/controllers/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
from . import mcp_controller
71 changes: 71 additions & 0 deletions ai_oca_mcp/controllers/mcp_controller.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
import json
import re

from odoo import fields, http
from odoo.http import request


class McpController(http.Controller):
@http.route(
"/mcp/<string:key>", type="http", auth="none", methods=["POST"], csrf=False
)
def mcp_endpoint(self, key, **kwargs):
match = re.match(
r"Bearer (.+)", request.httprequest.headers.get("Authorization", "")
)
payload = json.loads(request.httprequest.data.decode("utf-8"))
if not match:
return request.make_json_response(
{
"jsonrpc": "2.0",
"id": payload.get("id"),
"error": {"code": -32000, "message": "Connection failed"},
},
status=401,
)
security_key = match.group(1).strip()
server_id, expiration_date = (
request.env["mcp.server.key"]
.sudo()
._get_mcp_server_by_key(key, security_key)
)
if expiration_date and expiration_date < fields.Datetime.now():
request.env["mcp.server.key"].sudo().browse(server_id).expire_key()
server_id = False
if not server_id:
return request.make_json_response(
{
"jsonrpc": "2.0",
"id": payload.get("id"),
"error": {"code": -32000, "message": "Connection failed"},
}
)
server = request.env["mcp.server.key"].sudo().browse(server_id)
server = server.with_user(server.user_id.id)
method = payload.get("method")
if method == "initialize":
return request.make_json_response(
{
"jsonrpc": "2.0",
"id": payload.get("id"),
"result": {
"protocolVersion": "2025-03-26",
"capabilities": {"tools": {"listChanged": True}},
"serverInfo": {"name": "odoo-mcp", "version": "0.1.0"},
},
}
)

if method == "tools/list":
return request.make_json_response(server._tools_list(payload))

if method == "tools/call":
return request.make_json_response(server._tools_call(payload))

return request.make_json_response(
{
"jsonrpc": "2.0",
"id": payload.get("id"),
"error": {"code": -32601, "message": "Method not found"},
}
)
3 changes: 3 additions & 0 deletions ai_oca_mcp/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
from . import mcp_server
from . import mcp_server_key
from . import mcp_server_log
40 changes: 40 additions & 0 deletions ai_oca_mcp/models/mcp_server.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Copyright 2026 Dixmit
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

from uuid import uuid4

from odoo import api, fields, models


class McpServer(models.Model):

_name = "mcp.server"
_description = "Mcp Server"

name = fields.Char()
description = fields.Text()
active = fields.Boolean(default=True)
key = fields.Char(
required=True,
copy=False,
default=lambda self: uuid4(),
groups="base.group_system",
)
tool_ids = fields.Many2many(
"ai.tool", string="Tools", domain=[("kind", "=", "generic")]
)
url = fields.Char(
compute="_compute_url",
groups="base.group_system",
)
key_ids = fields.One2many("mcp.server.key", "server_id", string="Access Keys")

_sql_constraints = [
("key_uniq", "unique(key)", "The key must be unique"),
]

@api.depends("key")
def _compute_url(self):
base_url = self.env["ir.config_parameter"].sudo().get_param("web.base.url")
for record in self:
record.url = f"{base_url}/mcp/{record.key}"
105 changes: 105 additions & 0 deletions ai_oca_mcp/models/mcp_server_key.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
# Copyright 2026 Dixmit
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

import json
from hashlib import sha256

from odoo import api, fields, models, tools


class McpServerKey(models.Model):

_name = "mcp.server.key"
_description = "Mcp Server Key"

name = fields.Char(required=True)
server_id = fields.Many2one("mcp.server", required=True, ondelete="cascade")
hashed_key = fields.Char(copy=False)
state = fields.Selection(
[("active", "Active"), ("expired", "Expired")], default="active"
)
user_id = fields.Many2one("res.users", default=lambda self: self.env.user)
expiration_date = fields.Datetime()
expired_on = fields.Datetime(readonly=True)

def expire_key(self):
self.filtered(lambda key: key.state == "active").write(
{
"state": "expired",
"expired_on": fields.Datetime.now(),
}
)
self._get_mcp_server_by_key.clear_cache(self)

_sql_constraints = [
("key_uniq", "unique(hashed_key)", "The key must be unique"),
]

@api.model
def _hash_key(self, key):
return sha256(key.encode()).hexdigest()

@tools.ormcache("key", "security_key")
def _get_mcp_server_by_key(self, key, security_key):
key = self.sudo().search(
[
("server_id.key", "=", key),
("server_id.active", "=", True),
("hashed_key", "=", self._hash_key(security_key)),
"|",
("expiration_date", "=", False),
("expiration_date", ">", fields.Datetime.now()),
("state", "=", "active"),
],
limit=1,
)
return (key.id, key.expiration_date) if key else (False, False)

def _tools_list(self, payload):
tools = self.server_id.tool_ids
result = []
for tool in tools:
result.append(tool._get_tool_definition())
return {"jsonrpc": "2.0", "id": payload.get("id"), "result": {"tools": result}}

def _tools_call(self, payload):
params = payload.get("params", {})
tool_name = params.get("name")
args = params.get("arguments", {})
result_vals = {
"request": json.dumps(params),
"server_id": self.server_id.id,
"server_key_id": self.id,
}

tool = self.server_id.tool_ids.filtered(lambda t: t.name == tool_name)

if not tool:
self._add_log(**result_vals, error="Tool not found")
return {
"jsonrpc": "2.0",
"id": payload.get("id"),
"error": {"code": -32000, "message": "Unknown tool"},
}
try:
with self.env.cr.savepoint(flush=False):
result = tool._execute_tool(**args) or {}
self._add_log(**result_vals, response=json.dumps(result))
return {
"jsonrpc": "2.0",
"id": payload.get("id"),
"result": {
"structuredContent": result,
"content": [{"type": "text", "text": json.dumps(result)}],
},
}
except Exception as e:
self._add_log(**result_vals, error=str(e))
return {
"jsonrpc": "2.0",
"id": payload.get("id"),
"error": {"code": -32000, "message": str(e)},
}

def _add_log(self, **log_vals):
return self.env["mcp.server.log"].sudo().create(log_vals)
16 changes: 16 additions & 0 deletions ai_oca_mcp/models/mcp_server_log.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Copyright 2026 Dixmit
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).

from odoo import fields, models


class McpServerLog(models.Model):
_name = "mcp.server.log"
_description = "Mcp Server Log"

server_id = fields.Many2one("mcp.server", required=True, ondelete="cascade")
server_key_id = fields.Many2one("mcp.server.key", required=True, ondelete="cascade")
request = fields.Text()
response = fields.Text()
error = fields.Text()
date = fields.Datetime(default=fields.Datetime.now, index=True)
2 changes: 2 additions & 0 deletions ai_oca_mcp/readme/CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- [Dixmit](https://www.dixmit.com)
- Enric Tobella
Loading
Loading