odoo-mcp 0.0.1__tar.gz

odoo_mcp-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Lê Anh Tuấn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

odoo_mcp-0.0.1/PKG-INFO

@@ -0,0 +1,245 @@
+Metadata-Version: 2.2
+Name: odoo-mcp
+Version: 0.0.1
+Summary: MCP Server for Odoo Integration
+Author-email: Lê Anh Tuấn <justin.le.1105@gmail.com>
+Project-URL: Homepage, https://github.com/tuanle03/mcp-odoo
+Project-URL: Issues, https://github.com/tuanle03/mcp-odoo/issues
+Keywords: odoo,mcp,server
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+
+# Odoo MCP Server
+
+An MCP server implementation that integrates with Odoo ERP systems, enabling AI assistants to interact with Odoo data and functionality through the Model Context Protocol.
+
+## Features
+
+* **Comprehensive Odoo Integration**: Full access to Odoo models, records, and methods
+* **XML-RPC Communication**: Secure connection to Odoo instances via XML-RPC
+* **Flexible Configuration**: Support for config files and environment variables
+* **Resource Pattern System**: URI-based access to Odoo data structures
+* **Error Handling**: Clear error messages for common Odoo API issues
+* **Stateless Operations**: Clean request/response cycle for reliable integration
+
+## Tools
+
+* **search_records**
+  * Search for records in any Odoo model
+  * Inputs:
+    * `model` (string): The model name (e.g., 'res.partner')
+    * `domain` (array): Search domain (e.g., [['is_company', '=', true]])
+    * `fields` (optional array): Optional fields to fetch
+    * `limit` (optional number): Maximum number of records to return
+  * Returns: Matching records with requested fields
+
+* **read_record**
+  * Read details of a specific record
+  * Inputs:
+    * `model` (string): The model name (e.g., 'res.partner')
+    * `id` (number): The record ID
+    * `fields` (optional array): Optional fields to fetch
+  * Returns: Record data with requested fields
+
+* **create_record**
+  * Create a new record in Odoo
+  * Inputs:
+    * `model` (string): The model name (e.g., 'res.partner')
+    * `values` (object): Dictionary of field values
+  * Returns: Dictionary with the new record ID
+
+* **update_record**
+  * Update an existing record
+  * Inputs:
+    * `model` (string): The model name (e.g., 'res.partner')
+    * `id` (number): The record ID
+    * `values` (object): Dictionary of field values to update
+  * Returns: Dictionary indicating success
+
+* **delete_record**
+  * Delete a record from Odoo
+  * Inputs:
+    * `model` (string): The model name (e.g., 'res.partner')
+    * `id` (number): The record ID
+  * Returns: Dictionary indicating success
+
+* **execute_method**
+  * Execute a custom method on an Odoo model
+  * Inputs:
+    * `model` (string): The model name (e.g., 'res.partner')
+    * `method` (string): Method name to execute
+    * `args` (optional array): Positional arguments
+    * `kwargs` (optional object): Keyword arguments
+  * Returns: Dictionary with the method result
+
+* **get_model_fields**
+  * Get field definitions for a model
+  * Inputs:
+    * `model` (string): The model name (e.g., 'res.partner')
+  * Returns: Dictionary with field definitions
+
+## Resources
+
+* **odoo://models**
+  * Lists all available models in the Odoo system
+  * Returns: JSON array of model information
+
+* **odoo://model/{model_name}**
+  * Get information about a specific model including fields
+  * Example: `odoo://model/res.partner`
+  * Returns: JSON object with model metadata and field definitions
+
+* **odoo://record/{model_name}/{record_id}**
+  * Get a specific record by ID
+  * Example: `odoo://record/res.partner/1`
+  * Returns: JSON object with record data
+
+* **odoo://search/{model_name}/{domain}**
+  * Search for records that match a domain
+  * Example: `odoo://search/res.partner/[["is_company","=",true]]`
+  * Returns: JSON array of matching records (limited to 10 by default)
+
+## Configuration
+
+### Odoo Connection Setup
+
+1. Create a configuration file named `odoo_config.json`:
+
+```json
+{
+  "url": "https://your-odoo-instance.com",
+  "db": "your-database-name",
+  "username": "your-username",
+  "password": "your-password-or-api-key"
+}
+```
+
+2. Alternatively, use environment variables:
+   * `ODOO_URL`: Your Odoo server URL
+   * `ODOO_DB`: Database name
+   * `ODOO_USERNAME`: Login username
+   * `ODOO_PASSWORD`: Password or API key
+   * `ODOO_TIMEOUT`: Connection timeout in seconds (default: 30)
+   * `ODOO_VERIFY_SSL`: Whether to verify SSL certificates (default: true)
+
+### Usage with Claude Desktop
+
+Add this to your `claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "odoo": {
+      "command": "python",
+      "args": [
+        "-m",
+        "odoo_mcp"
+      ],
+      "env": {
+        "ODOO_URL": "https://your-odoo-instance.com",
+        "ODOO_DB": "your-database-name",
+        "ODOO_USERNAME": "your-username",
+        "ODOO_PASSWORD": "your-password-or-api-key"
+      }
+    }
+  }
+}
+```
+
+### Docker
+
+```json
+{
+  "mcpServers": {
+    "odoo": {
+      "command": "docker",
+      "args": [
+        "run",
+        "-i",
+        "--rm",
+        "-e",
+        "ODOO_URL",
+        "-e",
+        "ODOO_DB",
+        "-e",
+        "ODOO_USERNAME",
+        "-e",
+        "ODOO_PASSWORD",
+        "mcp/odoo"
+      ],
+      "env": {
+        "ODOO_URL": "https://your-odoo-instance.com",
+        "ODOO_DB": "your-database-name",
+        "ODOO_USERNAME": "your-username",
+        "ODOO_PASSWORD": "your-password-or-api-key"
+      }
+    }
+  }
+}
+```
+
+## Installation
+
+### Python Package
+
+```bash
+pip install odoo-mcp
+```
+
+### Running the Server
+
+```bash
+# Using the installed package
+odoo-mcp
+
+# Using the MCP development tools
+mcp dev odoo_mcp/server.py
+
+# With additional dependencies
+mcp dev odoo_mcp/server.py --with pandas --with numpy
+
+# Mount local code for development
+mcp dev odoo_mcp/server.py --with-editable .
+```
+
+## Build
+
+Docker build:
+
+```bash
+docker build -t mcp/odoo:latest -f Dockerfile .
+```
+
+## Parameter Formatting Guidelines
+
+When using the MCP tools for Odoo, pay attention to these parameter formatting guidelines:
+
+1. **Domain Parameter**:
+   * The following domain formats are supported:
+     * List format: `[["field", "operator", value], ...]`
+     * Object format: `{"conditions": [{"field": "...", "operator": "...", "value": "..."}]}`
+     * JSON string of either format
+   * Examples:
+     * List format: `[["is_company", "=", true]]`
+     * Object format: `{"conditions": [{"field": "date_order", "operator": ">=", "value": "2025-03-01"}]}`
+     * Multiple conditions: `[["date_order", ">=", "2025-03-01"], ["date_order", "<=", "2025-03-31"]]`
+
+2. **Fields Parameter**:
+   * Should be an array of field names: `["name", "email", "phone"]`
+   * The server will try to parse string inputs as JSON
+
+## License
+
+This MCP server is licensed under the MIT License.

odoo_mcp-0.0.1/README.md

@@ -0,0 +1,222 @@
+# Odoo MCP Server
+
+An MCP server implementation that integrates with Odoo ERP systems, enabling AI assistants to interact with Odoo data and functionality through the Model Context Protocol.
+
+## Features
+
+* **Comprehensive Odoo Integration**: Full access to Odoo models, records, and methods
+* **XML-RPC Communication**: Secure connection to Odoo instances via XML-RPC
+* **Flexible Configuration**: Support for config files and environment variables
+* **Resource Pattern System**: URI-based access to Odoo data structures
+* **Error Handling**: Clear error messages for common Odoo API issues
+* **Stateless Operations**: Clean request/response cycle for reliable integration
+
+## Tools
+
+* **search_records**
+  * Search for records in any Odoo model
+  * Inputs:
+    * `model` (string): The model name (e.g., 'res.partner')
+    * `domain` (array): Search domain (e.g., [['is_company', '=', true]])
+    * `fields` (optional array): Optional fields to fetch
+    * `limit` (optional number): Maximum number of records to return
+  * Returns: Matching records with requested fields
+
+* **read_record**
+  * Read details of a specific record
+  * Inputs:
+    * `model` (string): The model name (e.g., 'res.partner')
+    * `id` (number): The record ID
+    * `fields` (optional array): Optional fields to fetch
+  * Returns: Record data with requested fields
+
+* **create_record**
+  * Create a new record in Odoo
+  * Inputs:
+    * `model` (string): The model name (e.g., 'res.partner')
+    * `values` (object): Dictionary of field values
+  * Returns: Dictionary with the new record ID
+
+* **update_record**
+  * Update an existing record
+  * Inputs:
+    * `model` (string): The model name (e.g., 'res.partner')
+    * `id` (number): The record ID
+    * `values` (object): Dictionary of field values to update
+  * Returns: Dictionary indicating success
+
+* **delete_record**
+  * Delete a record from Odoo
+  * Inputs:
+    * `model` (string): The model name (e.g., 'res.partner')
+    * `id` (number): The record ID
+  * Returns: Dictionary indicating success
+
+* **execute_method**
+  * Execute a custom method on an Odoo model
+  * Inputs:
+    * `model` (string): The model name (e.g., 'res.partner')
+    * `method` (string): Method name to execute
+    * `args` (optional array): Positional arguments
+    * `kwargs` (optional object): Keyword arguments
+  * Returns: Dictionary with the method result
+
+* **get_model_fields**
+  * Get field definitions for a model
+  * Inputs:
+    * `model` (string): The model name (e.g., 'res.partner')
+  * Returns: Dictionary with field definitions
+
+## Resources
+
+* **odoo://models**
+  * Lists all available models in the Odoo system
+  * Returns: JSON array of model information
+
+* **odoo://model/{model_name}**
+  * Get information about a specific model including fields
+  * Example: `odoo://model/res.partner`
+  * Returns: JSON object with model metadata and field definitions
+
+* **odoo://record/{model_name}/{record_id}**
+  * Get a specific record by ID
+  * Example: `odoo://record/res.partner/1`
+  * Returns: JSON object with record data
+
+* **odoo://search/{model_name}/{domain}**
+  * Search for records that match a domain
+  * Example: `odoo://search/res.partner/[["is_company","=",true]]`
+  * Returns: JSON array of matching records (limited to 10 by default)
+
+## Configuration
+
+### Odoo Connection Setup
+
+1. Create a configuration file named `odoo_config.json`:
+
+```json
+{
+  "url": "https://your-odoo-instance.com",
+  "db": "your-database-name",
+  "username": "your-username",
+  "password": "your-password-or-api-key"
+}
+```
+
+2. Alternatively, use environment variables:
+   * `ODOO_URL`: Your Odoo server URL
+   * `ODOO_DB`: Database name
+   * `ODOO_USERNAME`: Login username
+   * `ODOO_PASSWORD`: Password or API key
+   * `ODOO_TIMEOUT`: Connection timeout in seconds (default: 30)
+   * `ODOO_VERIFY_SSL`: Whether to verify SSL certificates (default: true)
+
+### Usage with Claude Desktop
+
+Add this to your `claude_desktop_config.json`:
+
+```json
+{
+  "mcpServers": {
+    "odoo": {
+      "command": "python",
+      "args": [
+        "-m",
+        "odoo_mcp"
+      ],
+      "env": {
+        "ODOO_URL": "https://your-odoo-instance.com",
+        "ODOO_DB": "your-database-name",
+        "ODOO_USERNAME": "your-username",
+        "ODOO_PASSWORD": "your-password-or-api-key"
+      }
+    }
+  }
+}
+```
+
+### Docker
+
+```json
+{
+  "mcpServers": {
+    "odoo": {
+      "command": "docker",
+      "args": [
+        "run",
+        "-i",
+        "--rm",
+        "-e",
+        "ODOO_URL",
+        "-e",
+        "ODOO_DB",
+        "-e",
+        "ODOO_USERNAME",
+        "-e",
+        "ODOO_PASSWORD",
+        "mcp/odoo"
+      ],
+      "env": {
+        "ODOO_URL": "https://your-odoo-instance.com",
+        "ODOO_DB": "your-database-name",
+        "ODOO_USERNAME": "your-username",
+        "ODOO_PASSWORD": "your-password-or-api-key"
+      }
+    }
+  }
+}
+```
+
+## Installation
+
+### Python Package
+
+```bash
+pip install odoo-mcp
+```
+
+### Running the Server
+
+```bash
+# Using the installed package
+odoo-mcp
+
+# Using the MCP development tools
+mcp dev odoo_mcp/server.py
+
+# With additional dependencies
+mcp dev odoo_mcp/server.py --with pandas --with numpy
+
+# Mount local code for development
+mcp dev odoo_mcp/server.py --with-editable .
+```
+
+## Build
+
+Docker build:
+
+```bash
+docker build -t mcp/odoo:latest -f Dockerfile .
+```
+
+## Parameter Formatting Guidelines
+
+When using the MCP tools for Odoo, pay attention to these parameter formatting guidelines:
+
+1. **Domain Parameter**:
+   * The following domain formats are supported:
+     * List format: `[["field", "operator", value], ...]`
+     * Object format: `{"conditions": [{"field": "...", "operator": "...", "value": "..."}]}`
+     * JSON string of either format
+   * Examples:
+     * List format: `[["is_company", "=", true]]`
+     * Object format: `{"conditions": [{"field": "date_order", "operator": ">=", "value": "2025-03-01"}]}`
+     * Multiple conditions: `[["date_order", ">=", "2025-03-01"], ["date_order", "<=", "2025-03-31"]]`
+
+2. **Fields Parameter**:
+   * Should be an array of field names: `["name", "email", "phone"]`
+   * The server will try to parse string inputs as JSON
+
+## License
+
+This MCP server is licensed under the MIT License.

odoo_mcp-0.0.1/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "odoo-mcp"
+version = "0.0.1"
+description = "MCP Server for Odoo Integration"
+readme = "README.md"
+requires-python = ">=3.10"
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Operating System :: OS Independent",
+]
+keywords = ["odoo", "mcp", "server"]
+authors = [
+    {name = "Lê Anh Tuấn", email = "justin.le.1105@gmail.com"}
+]
+
+[project.urls]
+Homepage = "https://github.com/tuanle03/mcp-odoo"
+Issues = "https://github.com/tuanle03/mcp-odoo/issues"
+
+[project.optional-dependencies]
+dev = [
+    "black",
+    "isort",
+    "mypy",
+    "ruff",
+    "build",
+    "twine",
+]
+
+[project.scripts]
+odoo-mcp = "odoo_mcp.__main__:main"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+packages = ["odoo_mcp"]
+
+[tool.black]
+line-length = 88
+target-version = ["py310"]
+
+[tool.isort]
+profile = "black"
+line_length = 88
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true

odoo_mcp-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

odoo_mcp-0.0.1/src/odoo_mcp/__init__.py

@@ -0,0 +1,7 @@
+"""
+Odoo MCP Server - MCP Server for Odoo Integration
+"""
+
+from .server import mcp
+
+__all__ = ["mcp"]

odoo_mcp-0.0.1/src/odoo_mcp/__main__.py

@@ -0,0 +1,54 @@
+"""
+Command line entry point for the Odoo MCP Server
+"""
+import sys
+import asyncio
+import traceback
+import os
+
+from .server import mcp
+
+
+def main() -> int:
+    """
+    Run the MCP server
+    """
+    try:
+        print("=== ODOO MCP SERVER STARTING ===", file=sys.stderr)
+        print(f"Python version: {sys.version}", file=sys.stderr)
+        print("Environment variables:", file=sys.stderr)
+        for key, value in os.environ.items():
+            if key.startswith("ODOO_"):
+                if key == "ODOO_PASSWORD":
+                    print(f"  {key}: ***hidden***", file=sys.stderr)
+                else:
+                    print(f"  {key}: {value}", file=sys.stderr)
+        
+        # Check if server instance has the run_stdio method
+        methods = [method for method in dir(mcp) if not method.startswith('_')]
+        print(f"Available methods on mcp object: {methods}", file=sys.stderr)
+        
+        print("Starting MCP server with run() method...", file=sys.stderr)
+        sys.stderr.flush()  # Ensure log information is written immediately
+        
+        # Use the run() method directly
+        mcp.run()
+        
+        # If execution reaches here, the server exited normally
+        print("MCP server stopped normally", file=sys.stderr)
+        return 0
+    except KeyboardInterrupt:
+        print("MCP server stopped by user", file=sys.stderr)
+        return 0
+    except Exception as e:
+        print(f"Error starting server: {e}", file=sys.stderr)
+        print("Exception details:", file=sys.stderr)
+        traceback.print_exc(file=sys.stderr)
+        print("\nServer object information:", file=sys.stderr)
+        print(f"MCP object type: {type(mcp)}", file=sys.stderr)
+        print(f"MCP object dir: {dir(mcp)}", file=sys.stderr)
+        return 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())