diff --git a/ai_automation/README.rst b/ai_automation/README.rst new file mode 100644 index 00000000..cf7a7923 --- /dev/null +++ b/ai_automation/README.rst @@ -0,0 +1,108 @@ +.. image:: https://odoo-community.org/readme-banner-image + :target: https://odoo-community.org/get-involved?utm_source=readme + :alt: Odoo Community Association + +============= +Ai Automation +============= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:9db8aa67499c9f7efc73ff5f14809ca6d3df0f99e4eb35df8fff7f4cd3de79d1 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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_automation + :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_automation + :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 integrates AI connections with Odoo server actions, allowing +you to define AI-powered automations. By default it provides Ollama +support, but it can be extended with additional providers by adding new +``kind`` options to ``ai.connection``. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +This module adds a new server action type: **AI OCA Action**. + +To use it: + +1. Go to ``Settings > Technical > Actions > Server Actions`` +2. Create a new action and select **AI OCA Action** as the state +3. Select an AI Connection (Ollama) +4. Define the prompt — supports dynamic placeholders using Qweb syntax + (e.g. ``{{ object.name }}``) +5. Optionally select tools the AI can call during execution +6. Define what to do with the result: + + - **Post Message**: posts the AI response as a chatter message on the + record + - **Update Record**: writes the AI response to a specific field + +To extend with a new AI provider, inherit ``ai.connection`` and add a +new selection value to ``kind``, then implement the corresponding +``_run_{kind}`` method. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub 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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Dixmit + +Contributors +------------ + +- `Dixmit `__ + + - 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 `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/ai_automation/__init__.py b/ai_automation/__init__.py new file mode 100644 index 00000000..0650744f --- /dev/null +++ b/ai_automation/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/ai_automation/__manifest__.py b/ai_automation/__manifest__.py new file mode 100644 index 00000000..07d0262b --- /dev/null +++ b/ai_automation/__manifest__.py @@ -0,0 +1,21 @@ +# Copyright 2026 Dixmit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +{ + "name": "Ai Automation", + "summary": """Integrate `ai_tools` with server actions to automate tasks using AI.""", + "version": "16.0.1.0.0", + "license": "AGPL-3", + "author": "Dixmit,Odoo Community Association (OCA)", + "website": "https://github.com/OCA/ai", + "depends": ["ai_tool"], + "external_dependencies": { + "python": ["ollama"], + }, + "data": [ + "views/ir_actions_server.xml", + "security/ir.model.access.csv", + "views/ai_connection.xml", + ], + "demo": [], +} diff --git a/ai_automation/models/__init__.py b/ai_automation/models/__init__.py new file mode 100644 index 00000000..f2ab448f --- /dev/null +++ b/ai_automation/models/__init__.py @@ -0,0 +1,2 @@ +from . import ai_connection +from . import ir_actions_server diff --git a/ai_automation/models/ai_connection.py b/ai_automation/models/ai_connection.py new file mode 100644 index 00000000..0419c58d --- /dev/null +++ b/ai_automation/models/ai_connection.py @@ -0,0 +1,73 @@ +# Copyright 2026 Dixmit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +import json + +import ollama + +from odoo import fields, models + + +class AiConnection(models.Model): + _name = "ai.connection" + _description = "AI Connection" + + name = fields.Char(required=True) + kind = fields.Selection([("ollama", "Ollama")], required=True, default="ollama") + active = fields.Boolean(default=True) + url = fields.Char(groups="base.group_system") + model = fields.Char(groups="base.group_system") + + def _run(self, prompt, tools=None, record=None): + return getattr(self, f"_run_{self.kind}")(prompt, tools=tools, record=record) + + def _run_ollama(self, prompt, tools=None, messages=None, record=None): + tool_definition = [] + for tool in tools or []: + definition = tool._get_tool_definition() + input_schema = definition["inputSchema"] + input_schema["additionalProperties"] = False + tool_definition.append( + { + "type": "function", + "function": { + "name": definition["name"], + "description": definition["description"], + "parameters": input_schema, + }, + } + ) + ollama_client = ollama.Client(**self._get_ollama_client_parameters()) + if messages is None: + messages = [] + messages.append({"role": "user", "content": prompt}) + while True: + response = ollama_client.chat( + model=self.model, + messages=messages, + tools=tool_definition, + ) + if not response.message.tool_calls: + return response.message.content + messages.append(response.message) + for call in response.message.tool_calls: + tool = tools.filtered(lambda t: t.name == call.function.name) + tool_output = tool._execute_tool( + record=record, **call.function.arguments + ) + if isinstance(tool_output, dict): + tool_output = json.dumps(tool_output) + messages.append( + { + "role": "tool", + "tool_name": call.function.name, + "content": tool_output, + } + ) + + def _get_ollama_client_parameters(self): + """ + We provide this hook so people can modify the client and other configurations + like headers and so on. + """ + return {"host": self.url, "headers": {}} diff --git a/ai_automation/models/ir_actions_server.py b/ai_automation/models/ir_actions_server.py new file mode 100644 index 00000000..cbcb4f88 --- /dev/null +++ b/ai_automation/models/ir_actions_server.py @@ -0,0 +1,72 @@ +# Copyright 2026 Dixmit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +from lxml import etree + +from odoo import api, fields, models + +from odoo.addons.web_editor.models.ir_qweb_fields import html_to_text + + +class IrActionsServer(models.Model): + + _inherit = "ir.actions.server" + + state = fields.Selection( + selection_add=[("ai_oca", "AI OCA Action")], ondelete={"ai_oca": "cascade"} + ) + ai_connection_id = fields.Many2one( + "ai.connection", string="AI Connection", groups="base.group_system" + ) + ai_tool_ids = fields.Many2many( + "ai.tool", + string="AI Tools", + groups="base.group_system", + ) + ai_prompt = fields.Html(string="AI Prompt", sanitize=False) + mailing_model_real = fields.Char(compute="_compute_mailing_model_real") + ai_result_action = fields.Selection( + [ + ("post_message", "Post Message"), + ("update_record", "Update Record"), + ], + string="AI Result Action", + ) + ai_update_record_field_id = fields.Many2one( + "ir.model.fields", + string="AI Update Record Field", + domain="[('model_id', '=', model_id), ('ttype', 'in', ['char', 'text'])]", + ) + + @api.depends("model_id") + def _compute_mailing_model_real(self): + for record in self: + record.mailing_model_real = ( + record.model_id.model if record.model_id else False + ) + + def _run_action_ai_oca(self, eval_context=None): + record = eval_context.get("record") + result = self.ai_connection_id._run( + self._get_ai_oca_prompt(record), tools=self.ai_tool_ids, record=record + ) + self._post_run_action_ai_oca(result, record) + + def _post_run_action_ai_oca(self, result, record): + if self.ai_result_action == "post_message": + self.env["ai.tool"]._ai_post_message(result, record=record) + elif ( + self.ai_result_action == "update_record" + and record + and self.ai_update_record_field_id + ): + record.write({self.ai_update_record_field_id.name: result}) + + def _get_ai_oca_prompt(self, record): + ai_prompt = self.ai_prompt + if record: + ai_prompt = str( + self.env["mail.render.mixin"]._render_template_qweb( + self.ai_prompt, record and record._name, record and record.ids + )[record.id] + ) + return html_to_text(etree.fromstring("" + ai_prompt + "")) diff --git a/ai_automation/readme/CONTRIBUTORS.md b/ai_automation/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..2c066ba7 --- /dev/null +++ b/ai_automation/readme/CONTRIBUTORS.md @@ -0,0 +1,2 @@ +- [Dixmit](https://www.dixmit.com) + - Enric Tobella diff --git a/ai_automation/readme/DESCRIPTION.md b/ai_automation/readme/DESCRIPTION.md new file mode 100644 index 00000000..7fa64139 --- /dev/null +++ b/ai_automation/readme/DESCRIPTION.md @@ -0,0 +1,3 @@ +This module integrates AI connections with Odoo server actions, allowing you to +define AI-powered automations. By default it provides Ollama support, but it can +be extended with additional providers by adding new `kind` options to `ai.connection`. diff --git a/ai_automation/readme/USAGE.md b/ai_automation/readme/USAGE.md new file mode 100644 index 00000000..e597ad9a --- /dev/null +++ b/ai_automation/readme/USAGE.md @@ -0,0 +1,14 @@ +This module adds a new server action type: **AI OCA Action**. + +To use it: +1. Go to `Settings > Technical > Actions > Server Actions` +2. Create a new action and select **AI OCA Action** as the state +3. Select an AI Connection (Ollama) +4. Define the prompt — supports dynamic placeholders using Qweb syntax (e.g. `{{ object.name }}`) +5. Optionally select tools the AI can call during execution +6. Define what to do with the result: + - **Post Message**: posts the AI response as a chatter message on the record + - **Update Record**: writes the AI response to a specific field + +To extend with a new AI provider, inherit `ai.connection` and add a new selection +value to `kind`, then implement the corresponding `_run_{kind}` method. \ No newline at end of file diff --git a/ai_automation/security/ir.model.access.csv b/ai_automation/security/ir.model.access.csv new file mode 100644 index 00000000..9d762bd9 --- /dev/null +++ b/ai_automation/security/ir.model.access.csv @@ -0,0 +1,3 @@ +id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink +access_ai_connection,access_ai_connection,model_ai_connection,base.group_user,1,0,0,0 +manage_ai_connection,manage_ai_connection,model_ai_connection,base.group_system,1,1,1,0 diff --git a/ai_automation/static/description/icon.png b/ai_automation/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/ai_automation/static/description/icon.png differ diff --git a/ai_automation/static/description/index.html b/ai_automation/static/description/index.html new file mode 100644 index 00000000..c8b600b8 --- /dev/null +++ b/ai_automation/static/description/index.html @@ -0,0 +1,458 @@ + + + + + +README.rst + + + +
+ + + +Odoo Community Association + +
+

Ai Automation

+ +

Beta License: AGPL-3 OCA/ai Translate me on Weblate Try me on Runboat

+

This module integrates AI connections with Odoo server actions, allowing +you to define AI-powered automations. By default it provides Ollama +support, but it can be extended with additional providers by adding new +kind options to ai.connection.

+

Table of contents

+ +
+

Usage

+

This module adds a new server action type: AI OCA Action.

+

To use it:

+
    +
  1. Go to Settings > Technical > Actions > Server Actions
    2. +
  2. Create a new action and select AI OCA Action as the state
    3. +
  3. Select an AI Connection (Ollama)
    4. +
  4. Define the prompt — supports dynamic placeholders using Qweb syntax +(e.g. {{ object.name }})
    5. +
  5. Optionally select tools the AI can call during execution
    6. +
  6. Define what to do with the result:
      +
    • Post Message: posts the AI response as a chatter message on the +record
      • +
    • Update Record: writes the AI response to a specific field
      • +
    +
    7. +
+

To extend with a new AI provider, inherit ai.connection and add a +new selection value to kind, then implement the corresponding +_run_{kind} method.

+
+
+

Bug Tracker

+

Bugs are tracked on GitHub 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.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Dixmit
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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 project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+
+ + diff --git a/ai_automation/tests/__init__.py b/ai_automation/tests/__init__.py new file mode 100644 index 00000000..f1aa56d4 --- /dev/null +++ b/ai_automation/tests/__init__.py @@ -0,0 +1 @@ +from . import test_connection_ollama diff --git a/ai_automation/tests/test_connection_ollama.py b/ai_automation/tests/test_connection_ollama.py new file mode 100644 index 00000000..93335c27 --- /dev/null +++ b/ai_automation/tests/test_connection_ollama.py @@ -0,0 +1,134 @@ +# Copyright 2026 Dixmit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from unittest import mock + +from ollama._types import ChatResponse + +from odoo.tests.common import TransactionCase + + +class OllamaClient: + def __init__(self, chat_messages=None): + self.chat_messages = chat_messages or [] + self.current_message = -1 + self.calls = [] + + def chat(self, *args, **kwargs): + self.current_message += 1 + self.calls.append((args, kwargs)) + return ChatResponse.model_validate( + {"message": self.chat_messages[self.current_message]} + ) + + +class TestConnectionOllama(TransactionCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.connection = cls.env["ai.connection"].create( + { + "name": "Ollama Connection", + "url": "http://my_ollama_server:11434", + "model": "my_ollama_model", + "kind": "ollama", + } + ) + cls.action = cls.env["ir.actions.server"].create( + { + "name": "Test Action", + "model_id": cls.env.ref("base.model_res_partner").id, + "state": "ai_oca", + "ai_connection_id": cls.connection.id, + "ai_tool_ids": [(4, cls.env.ref("ai_tool.current_date").id)], + "ai_prompt": "What is the current date?", + } + ) + cls.partner = cls.env["res.partner"].create({"name": "Test Partner"}) + + def test_execute_action_with_tools(self): + client = OllamaClient( + [ + { + "role": "assistant", + "content": "", + "tool_calls": [ + { + "function": { + "name": "get_date", + "arguments": {}, + }, + "id": "1", + } + ], + }, + { + "role": "assistant", + "content": "Thanks it is 2024-01-01", + }, + ] + ) + with mock.patch("ollama.Client", return_value=client): + messages = self.partner.message_ids + self.action.with_context( + active_id=self.partner.id, active_model="res.partner" + ).run() + self.assertEqual(client.current_message, 1) + self.assertEqual(messages, self.partner.message_ids) + + def test_execute_action_post_message(self): + client = OllamaClient( + [ + { + "role": "assistant", + "content": "Thanks it is 2024-01-01", + }, + ] + ) + self.action.ai_result_action = "post_message" + with mock.patch("ollama.Client", return_value=client): + messages = self.partner.message_ids + self.action.with_context( + active_id=self.partner.id, active_model="res.partner" + ).run() + self.assertEqual(client.current_message, 0) + self.assertEqual(len(messages) + 1, len(self.partner.message_ids)) + self.assertRegex( + (self.partner.message_ids - messages).body, r".*2024-01-01.*" + ) + + def test_execute_action_field(self): + client = OllamaClient( + [ + { + "role": "assistant", + "content": "", + "tool_calls": [ + { + "function": { + "name": "get_date", + "arguments": {}, + }, + "id": "1", + } + ], + }, + { + "role": "assistant", + "content": "Thanks it is 2024-01-01", + }, + ] + ) + self.action.ai_result_action = "update_record" + self.action.ai_update_record_field_id = self.env.ref( + "base.field_res_partner__comment" + ) + self.partner.comment = "Initial Comment" + with mock.patch("ollama.Client", return_value=client): + messages = self.partner.message_ids + self.action.with_context( + active_id=self.partner.id, active_model="res.partner" + ).run() + self.assertEqual(client.current_message, 1) + self.assertEqual(messages, self.partner.message_ids) + self.assertRegex(self.partner.comment, r".*2024-01-01.*") diff --git a/ai_automation/views/ai_connection.xml b/ai_automation/views/ai_connection.xml new file mode 100644 index 00000000..acf18c19 --- /dev/null +++ b/ai_automation/views/ai_connection.xml @@ -0,0 +1,72 @@ + + + + + + ai.connection + +
+
+ + + + + + + + + + + + + + + + + + + + ai.connection + + + + + + + + + ai.connection + + + + + + + + + + AI Connection + ai.connection + tree,form + [] + {} + + + + AI Connection + + + + + + diff --git a/ai_automation/views/ir_actions_server.xml b/ai_automation/views/ir_actions_server.xml new file mode 100644 index 00000000..cc046e66 --- /dev/null +++ b/ai_automation/views/ir_actions_server.xml @@ -0,0 +1,42 @@ + + + + + + ir.actions.server + + + + + + + + + + + + + + + + + + + + diff --git a/ai_tool/README.rst b/ai_tool/README.rst new file mode 100644 index 00000000..5e06e332 --- /dev/null +++ b/ai_tool/README.rst @@ -0,0 +1,145 @@ +.. image:: https://odoo-community.org/readme-banner-image + :target: https://odoo-community.org/get-involved?utm_source=readme + :alt: Odoo Community Association + +======= +Ai Tool +======= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:24aba4610958ac085492da4b1fd0fe517144c8824ae25d8d3f6c44fe45c1388e + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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_tool + :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_tool + :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 technical module provides the base infrastructure for defining AI +tools in Odoo. It allows other modules to register callable functions as +AI tools, which can then be used by MCP servers, automation flows, or +any AI-native integration. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +This module is technical, however, it adds some specific functions that +might be used in glue modules. + +For example, if we want to add on sales a functionality to find the +sales on a period, we should do: + +.. code:: xml + + + + total_sale_order + Calculate the total amount of sale orders within a date range and optionally for a specific customer. + + _mcp_total_sale_order + + + +.. code:: python + + from odoo.addons.ai_tool import aitool + + class SaleOrder(models.Model): + _inherit = "sale.order" + + @aitool( + input_schema={ + "start_date": {"type": "date"}, + "end_date": {"type": "date"}, + "customer_id": {"type": "integer"}, + }, + required_inputs=["start_date", "end_date"], + output_schema={ + "amount_total": {"type": "number"}, + }, + ) + def _mcp_total_sale_order(self, start_date, end_date, customer_id=None): + domain = [("date_order", ">=", start_date), ("date_order", "<=", end_date)] + if customer_id: + domain.append(("partner_id", "=", customer_id)) + orders = self.read_group(domain, ["amount_total"], []) + return { + "amount_total": (orders[0]["amount_total"] or 0) if orders else 0, + } + +Be aware that this kind of elements must allways return a dict. All the +elements will be defined in output_schema. + +Also, for the signature of the functions, all fields must be in the +inputs with the exception of record. This argument is protected and is +used to define integrations with automation. This argument is required +in ``generic_model`` and ``record`` tools. + +On ``generic_model``\ s we are expecting this value because we want to +do a specific action with the model. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub 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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +------- + +* Dixmit + +Contributors +------------ + +- `Dixmit `__ + + - 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 `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/ai_tool/__init__.py b/ai_tool/__init__.py new file mode 100644 index 00000000..738a2eec --- /dev/null +++ b/ai_tool/__init__.py @@ -0,0 +1,2 @@ +from . import models +from . import tools diff --git a/ai_tool/__manifest__.py b/ai_tool/__manifest__.py new file mode 100644 index 00000000..e69e5037 --- /dev/null +++ b/ai_tool/__manifest__.py @@ -0,0 +1,22 @@ +# Copyright 2026 Dixmit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +{ + "name": "Ai Tool", + "summary": """We want to generate some specific AI Tools + that might be used in other places, like MCP or native.""", + "version": "16.0.1.0.0", + "license": "AGPL-3", + "author": "Dixmit,Odoo Community Association (OCA)", + "website": "https://github.com/OCA/ai", + "depends": [ + "mail", + ], + "data": [ + "security/ir.model.access.csv", + "views/menu.xml", + "views/ai_tool.xml", + "data/ai_tools.xml", + ], + "demo": [], +} diff --git a/ai_tool/data/ai_tools.xml b/ai_tool/data/ai_tools.xml new file mode 100644 index 00000000..d21afe69 --- /dev/null +++ b/ai_tool/data/ai_tools.xml @@ -0,0 +1,22 @@ + + + + + + get_date + Get the current date. + + _ai_get_date + generic + + + + post_message + Post a message to a record. + + _ai_post_message + generic_model + + + diff --git a/ai_tool/models/__init__.py b/ai_tool/models/__init__.py new file mode 100644 index 00000000..b6c10aa8 --- /dev/null +++ b/ai_tool/models/__init__.py @@ -0,0 +1 @@ +from . import ai_tool diff --git a/ai_tool/models/ai_tool.py b/ai_tool/models/ai_tool.py new file mode 100644 index 00000000..c01eee29 --- /dev/null +++ b/ai_tool/models/ai_tool.py @@ -0,0 +1,94 @@ +# Copyright 2026 Dixmit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from datetime import date + +from odoo import fields, models +from odoo.tools.mail import html_sanitize, plaintext2html + +from ..tools import aitool + +try: + import markdown +except ImportError: + markdown = None + + +class AiTool(models.Model): + + _name = "ai.tool" + _description = "AI Tool" + + name = fields.Char(required=True) + description = fields.Text() + model_id = fields.Many2one( + "ir.model", readonly=True, required=True, ondelete="cascade" + ) + function_name = fields.Char(readonly=True, required=True) + kind = fields.Selection( + [ + ("generic", "Generic"), + ("generic_model", "Generic but requires a record to work"), + ("record", "Record"), + ], + readonly=True, + required=True, + default="record", + ) + + def _get_tool_definition(self): + func = getattr(self.env[self.model_id.model], self.function_name) + return { + "name": self.name, + "description": self.description, + "inputSchema": func._ai_tool["input_schema"], + "outputSchema": func._ai_tool["output_schema"], + } + + @aitool( + input_schema={}, + output_schema={ + "date": {"type": "date"}, + }, + ) + def _ai_get_date(self): + return {"date": date.today().isoformat()} + + @aitool( + input_schema={ + "message": {"type": "string"}, + }, + required_inputs=["message"], + output_schema={}, + ) + def _ai_post_message(self, message=None, record=None, **kwargs): + if not record or not record.exists(): + raise ValueError("Record must be provided and exist to post a message") + record.message_post(body=self._ai_post_message_parse_body(message)) + return {} + + def _ai_post_message_parse_body(self, message): + """ + Using markdown library if available to convert markdown to html, + otherwise using plaintext2html as fallback + """ + if markdown: + return html_sanitize(markdown.markdown(message)) + return plaintext2html(message) + + def _execute_tool(self, *args, record=None, **kwargs): + if self.kind == "generic": + return getattr(self.env[self.model_id.model], self.function_name)( + *args, **kwargs + ) + if not record: + raise ValueError("Record must be provided for non-generic tools") + if self.kind == "generic_model": + return getattr(self.env[self.model_id.model], self.function_name)( + *args, record=record, **kwargs + ) + elif record._name != self.model_id.model: + raise ValueError( + f"Record model {record._name} does not match tool model {self.model_id.model}" + ) + return getattr(record, self.function_name)(*args, **kwargs) or {} diff --git a/ai_tool/readme/CONTRIBUTORS.md b/ai_tool/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..2c066ba7 --- /dev/null +++ b/ai_tool/readme/CONTRIBUTORS.md @@ -0,0 +1,2 @@ +- [Dixmit](https://www.dixmit.com) + - Enric Tobella diff --git a/ai_tool/readme/DESCRIPTION.md b/ai_tool/readme/DESCRIPTION.md new file mode 100644 index 00000000..71747f87 --- /dev/null +++ b/ai_tool/readme/DESCRIPTION.md @@ -0,0 +1,3 @@ +This technical module provides the base infrastructure for defining AI tools in Odoo. +It allows other modules to register callable functions as AI tools, which can then be +used by MCP servers, automation flows, or any AI-native integration. diff --git a/ai_tool/readme/USAGE.md b/ai_tool/readme/USAGE.md new file mode 100644 index 00000000..c18e4ae5 --- /dev/null +++ b/ai_tool/readme/USAGE.md @@ -0,0 +1,52 @@ +This module is technical, however, it adds some specific functions that might be used in glue modules. + +For example, if we want to add on sales a functionality to find the sales on a period, we should do: + +```xml + + + total_sale_order + Calculate the total amount of sale orders within a date range and optionally for a specific customer. + + _mcp_total_sale_order + + +``` + +```python +from odoo.addons.ai_tool import aitool + +class SaleOrder(models.Model): + _inherit = "sale.order" + + @aitool( + input_schema={ + "start_date": {"type": "date"}, + "end_date": {"type": "date"}, + "customer_id": {"type": "integer"}, + }, + required_inputs=["start_date", "end_date"], + output_schema={ + "amount_total": {"type": "number"}, + }, + ) + def _mcp_total_sale_order(self, start_date, end_date, customer_id=None): + domain = [("date_order", ">=", start_date), ("date_order", "<=", end_date)] + if customer_id: + domain.append(("partner_id", "=", customer_id)) + orders = self.read_group(domain, ["amount_total"], []) + return { + "amount_total": (orders[0]["amount_total"] or 0) if orders else 0, + } + +``` + +Be aware that this kind of elements must allways return a dict. All the elements will be defined in output_schema. + +Also, for the signature of the functions, all fields must be in the inputs with the exception of record. +This argument is protected and is used to define integrations with automation. +This argument is required in `generic_model` and `record` tools. + +On `generic_model`s we are expecting this value because we want to do a specific action with the model. diff --git a/ai_tool/security/ir.model.access.csv b/ai_tool/security/ir.model.access.csv new file mode 100644 index 00000000..4f6beed7 --- /dev/null +++ b/ai_tool/security/ir.model.access.csv @@ -0,0 +1,2 @@ +id,name,model_id:id,group_id:id,perm_read,perm_write,perm_create,perm_unlink +access_ai_tool,access_ai_tool,model_ai_tool,base.group_user,1,0,0,0 diff --git a/ai_tool/static/description/icon.png b/ai_tool/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/ai_tool/static/description/icon.png differ diff --git a/ai_tool/static/description/index.html b/ai_tool/static/description/index.html new file mode 100644 index 00000000..def5e728 --- /dev/null +++ b/ai_tool/static/description/index.html @@ -0,0 +1,489 @@ + + + + + +README.rst + + + +
+ + + +Odoo Community Association + +
+

Ai Tool

+ +

Beta License: AGPL-3 OCA/ai Translate me on Weblate Try me on Runboat

+

This technical module provides the base infrastructure for defining AI +tools in Odoo. It allows other modules to register callable functions as +AI tools, which can then be used by MCP servers, automation flows, or +any AI-native integration.

+

Table of contents

+ +
+

Usage

+

This module is technical, however, it adds some specific functions that +might be used in glue modules.

+

For example, if we want to add on sales a functionality to find the +sales on a period, we should do:

+
+<odoo>
+    <record model="ai.tool" id="total_sale_order_tool">
+        <field name="name">total_sale_order</field>
+        <field
+            name="description"
+        >Calculate the total amount of sale orders within a date range and optionally for a specific customer.</field>
+        <field name="model_id" ref="model_sale_order" />
+        <field name="function_name">_mcp_total_sale_order</field>
+    </record>
+</odoo>
+
+
+from odoo.addons.ai_tool import aitool
+
+class SaleOrder(models.Model):
+    _inherit = "sale.order"
+
+    @aitool(
+        input_schema={
+            "start_date": {"type": "date"},
+            "end_date": {"type": "date"},
+            "customer_id": {"type": "integer"},
+        },
+        required_inputs=["start_date", "end_date"],
+        output_schema={
+            "amount_total": {"type": "number"},
+        },
+    )
+    def _mcp_total_sale_order(self, start_date, end_date, customer_id=None):
+        domain = [("date_order", ">=", start_date), ("date_order", "<=", end_date)]
+        if customer_id:
+            domain.append(("partner_id", "=", customer_id))
+        orders = self.read_group(domain, ["amount_total"], [])
+        return {
+            "amount_total": (orders[0]["amount_total"] or 0) if orders else 0,
+        }
+
+

Be aware that this kind of elements must allways return a dict. All the +elements will be defined in output_schema.

+

Also, for the signature of the functions, all fields must be in the +inputs with the exception of record. This argument is protected and is +used to define integrations with automation. This argument is required +in generic_model and record tools.

+

On generic_models we are expecting this value because we want to +do a specific action with the model.

+
+
+

Bug Tracker

+

Bugs are tracked on GitHub 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.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Dixmit
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

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 project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+
+ + diff --git a/ai_tool/tests/__init__.py b/ai_tool/tests/__init__.py new file mode 100644 index 00000000..30e42873 --- /dev/null +++ b/ai_tool/tests/__init__.py @@ -0,0 +1 @@ +from . import test_ai_tool diff --git a/ai_tool/tests/test_ai_tool.py b/ai_tool/tests/test_ai_tool.py new file mode 100644 index 00000000..c9090aaf --- /dev/null +++ b/ai_tool/tests/test_ai_tool.py @@ -0,0 +1,49 @@ +# Copyright 2026 Dixmit +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from freezegun import freeze_time + +from odoo.tests.common import TransactionCase + + +class TestAiTool(TransactionCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.partner = cls.env["res.partner"].create({"name": "Test Partner"}) + + def test_tool(self): + definition = self.env.ref("ai_tool.current_date")._get_tool_definition() + self.assertEqual(definition["inputSchema"]["type"], "object") + self.assertEqual(definition["outputSchema"]["type"], "object") + + def test_get_date_tool(self): + with freeze_time("2024-01-01"): + tool = self.env.ref("ai_tool.current_date") + result = tool._execute_tool(record=tool) + self.assertEqual(result["date"], "2024-01-01") + + def test_post_message_tool(self): + partner = self.partner + messages = partner.message_ids + tool = self.env.ref("ai_tool.post_message") + tool._execute_tool(message="Hello World", record=partner) + self.assertEqual(len(partner.message_ids), len(messages) + 1) + self.assertRegex((partner.message_ids - messages).body, "Hello World") + + def test_tool_no_record(self): + tool = self.env.ref("ai_tool.post_message") + with self.assertRaises(ValueError): + tool._execute_tool(message="Hello World") + + def test_post_message_tool_no_record(self): + tool = self.env.ref("ai_tool.post_message") + tool.kind = "generic" + with self.assertRaises(ValueError): + tool._execute_tool(message="Hello World", record=self.partner) + + def test_post_message_tool_record_different_model(self): + tool = self.env.ref("ai_tool.post_message") + tool.kind = "record" + with self.assertRaises(ValueError): + tool._execute_tool(message="Hello World", record=self.partner) diff --git a/ai_tool/tools.py b/ai_tool/tools.py new file mode 100644 index 00000000..443a1b56 --- /dev/null +++ b/ai_tool/tools.py @@ -0,0 +1,18 @@ +from odoo.api import attrsetter + + +def aitool(input_schema: dict, output_schema: dict, required_inputs: list = None): + return attrsetter( + "_ai_tool", + { + "input_schema": { + "type": "object", + "properties": input_schema, + "required": required_inputs or [], + }, + "output_schema": { + "type": "object", + "properties": output_schema, + }, + }, + ) diff --git a/ai_tool/views/ai_tool.xml b/ai_tool/views/ai_tool.xml new file mode 100644 index 00000000..7ce1a38b --- /dev/null +++ b/ai_tool/views/ai_tool.xml @@ -0,0 +1,55 @@ + + + + + + ai.tool + +
+
+ + + + + + + + + + + + + ai.tool + + + + + + + + + ai.tool + + + + + + + + + AI Tool + ai.tool + tree,form + [] + {} + + + + AI Tool + + + + + + diff --git a/ai_tool/views/menu.xml b/ai_tool/views/menu.xml new file mode 100644 index 00000000..f897888c --- /dev/null +++ b/ai_tool/views/menu.xml @@ -0,0 +1,6 @@ + + + + + diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..4630c4e4 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +# generated from manifests external_dependencies +ollama diff --git a/setup/ai_automation/odoo/addons/ai_automation b/setup/ai_automation/odoo/addons/ai_automation new file mode 120000 index 00000000..f60a1c12 --- /dev/null +++ b/setup/ai_automation/odoo/addons/ai_automation @@ -0,0 +1 @@ +../../../../ai_automation \ No newline at end of file diff --git a/setup/ai_automation/setup.py b/setup/ai_automation/setup.py new file mode 100644 index 00000000..28c57bb6 --- /dev/null +++ b/setup/ai_automation/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +) diff --git a/setup/ai_tool/odoo/addons/ai_tool b/setup/ai_tool/odoo/addons/ai_tool new file mode 120000 index 00000000..5b80433e --- /dev/null +++ b/setup/ai_tool/odoo/addons/ai_tool @@ -0,0 +1 @@ +../../../../ai_tool \ No newline at end of file diff --git a/setup/ai_tool/setup.py b/setup/ai_tool/setup.py new file mode 100644 index 00000000..28c57bb6 --- /dev/null +++ b/setup/ai_tool/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +)