mseep-odoo-mcp 0.0.3__tar.gz

mseep_odoo_mcp-0.0.3/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.

mseep_odoo_mcp-0.0.3/PKG-INFO

@@ -0,0 +1,270 @@
+Metadata-Version: 2.4
+Name: mseep-odoo-mcp
+Version: 0.0.3
+Summary: MCP Server for Odoo Integration
+Home-page: 
+Author: mseep
+Author-email: Lê Anh Tuấn <justin.le.1105@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/tuanle96/mcp-odoo
+Project-URL: Issues, https://github.com/tuanle96/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.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mcp>=0.1.1
+Requires-Dist: requests>=2.31.0
+Requires-Dist: xmlrpc>=0.4.1
+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"
+Dynamic: author
+Dynamic: license-file
+Dynamic: requires-python
+
+# 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
+
+* **search_employee**
+  * Search for employees by name.
+  * Inputs:
+    * `name` (string): The name (or part of the name) to search for.
+    * `limit` (optional number): The maximum number of results to return (default 20).
+  * Returns: List of matching employee names and IDs.
+
+* **search_holidays**
+  * Searches for holidays within a specified date range.
+  * Inputs:
+    * `start_date` (string): Start date in YYYY-MM-DD format.
+    * `end_date` (string): End date in YYYY-MM-DD format.
+    * `employee_id` (optional number): Optional employee ID to filter holidays.
+  * Returns: List of holidays found.
+
+## 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)
+   * `HTTP_PROXY`: Force the ODOO connection to use an HTTP proxy
+
+### 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.

mseep_odoo_mcp-0.0.3/README.md

@@ -0,0 +1,238 @@
+# 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
+
+* **search_employee**
+  * Search for employees by name.
+  * Inputs:
+    * `name` (string): The name (or part of the name) to search for.
+    * `limit` (optional number): The maximum number of results to return (default 20).
+  * Returns: List of matching employee names and IDs.
+
+* **search_holidays**
+  * Searches for holidays within a specified date range.
+  * Inputs:
+    * `start_date` (string): Start date in YYYY-MM-DD format.
+    * `end_date` (string): End date in YYYY-MM-DD format.
+    * `employee_id` (optional number): Optional employee ID to filter holidays.
+  * Returns: List of holidays found.
+
+## 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)
+   * `HTTP_PROXY`: Force the ODOO connection to use an HTTP proxy
+
+### 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.

mseep_odoo_mcp-0.0.3/pyproject.toml

@@ -0,0 +1,76 @@
+[build-system]
+requires = [
+    "setuptools>=61.0",
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mseep-odoo-mcp"
+version = "0.0.3"
+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" },
+]
+dependencies = [
+    "mcp>=0.1.1",
+    "requests>=2.31.0",
+    "xmlrpc>=0.4.1",
+]
+
+[project.license]
+text = "MIT"
+
+[project.urls]
+Homepage = "https://github.com/tuanle96/mcp-odoo"
+Issues = "https://github.com/tuanle96/mcp-odoo/issues"
+
+[project.optional-dependencies]
+dev = [
+    "black",
+    "isort",
+    "mypy",
+    "ruff",
+    "build",
+    "twine",
+]
+
+[project.scripts]
+odoo-mcp = "odoo_mcp.__main__:main"
+
+[tool.setuptools]
+packages = [
+    "odoo_mcp",
+]
+
+[tool.setuptools.package-dir]
+"" = "src"
+
+[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

mseep_odoo_mcp-0.0.3/setup.cfg

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

mseep_odoo_mcp-0.0.3/setup.py

@@ -0,0 +1,20 @@
+
+from setuptools import setup, find_packages
+
+setup(
+    name="mseep-odoo-mcp",
+    version="0.0.3",
+    description="MCP Server for Odoo Integration",
+    author="mseep",
+    author_email="support@skydeck.ai",
+    url="",
+    packages=find_packages(),
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.6",
+    install_requires=['mcp>=0.1.1', 'requests>=2.31.0', 'xmlrpc>=0.4.1'],
+    keywords=["mseep"] + ['odoo', 'mcp', 'server'],
+)