📦 Pre-Installation Steps

Before installing and using the MCP Server module, please make sure you have:

1. Odoo (version 18.0 / 19.0) installed and running on your system or server.
2. Python 3.12+ available in your environment.
3. A valid Odoo base URL and an active API Key generated from your Odoo user account.
4. Administrative access to Odoo for module installation and configuration.
5. An MCP-compatible client (e.g., Claude Desktop, any MCP-enabled AI assistant).

⚙️ Module Installation in Odoo

After obtaining the module package:

1. Extract the .zip file and place the module folder into your Odoo addons directory:

   /path/to/odoo/addons/eb_mcp_server/
   

2. Restart your Odoo server to detect the new module:

   sudo systemctl restart odoo
   # or
   ./odoo-bin -c odoo.conf
   

3. In Odoo, navigate to:

   Settings → Activate Developer Mode

4. Go to Apps → Update Apps List, then search for MCP Server and click Install.

🔑 Generating an API Key

The MCP Server uses Odoo's built-in API key system for secure authentication. Follow the steps below to generate your API key:

1. Log in to your Odoo instance with an Administrator or authorized user account.
2. Click on your profile avatar (top-right corner of the screen) and select My Profile.
3. In your profile page, click on the Preferences tab.
4. Scroll down to the API Keys section and click the New API Key button.
5. A dialog box will appear — enter a meaningful label for the key (e.g., MCP Server) so you can identify it later.
6. Click Generate Key to confirm.
7. Odoo will display your key only once — make sure to:
   • Copy the key immediately.
   • Store it in a secure location (e.g., a password manager or a .env file).
   • Never share this key publicly or commit it to version control.

🔗 Connecting Your MCP Client

1. Open your MCP-compatible client (e.g., Claude Desktop).

2. In your MCP client configuration file (e.g., claude_desktop_config.json), add the following server entry:

   {
     "mcpServers": {
       "eb_odoo": {
         "command": "/path/to/your/venv/bin/mcp-server-odoo",
         "env": {
           "ODOO_URL": "Your_Odoo_URL",
           "ODOO_DB": "Your_DB_Name",
           "ODOO_API_KEY": "Your_API_KEY"
         }
       }
     },
     "preferences": {
       "menuBarEnabled": true,
       "sidebarMode": "chat",
       "coworkScheduledTasksEnabled": false
     }
   }
   

3. Replace the following placeholders:

   • ODOO_URL: Your Odoo instance URL (e.g., https://yourcompany.odoo.com)
   • ODOO_DB: Your Odoo database name
   • ODOO_API_KEY: The API key generated from your Odoo user profile

4. Save the configuration file and restart your MCP client.

The server will automatically connect to your Odoo instance and expose available models and operations to the AI assistant.

🛠️ Available Operations

Once connected, the MCP Server supports the following operations on Odoo models:

• search_records — Search and filter records using Odoo domain syntax
• get_record — Retrieve a specific record by ID
• create_record — Create new records in any enabled model
• update_record — Update fields on existing records
• delete_record — Remove records from the database
• list_models — List all models enabled for MCP access

Example models you can interact with include res.partner, sale.order, crm.lead, account.move, and more — based on your configuration.

🔒 Security Information

• All connections are secured using Odoo's API key authentication over HTTPS.
• Access is strictly limited to models and operations enabled by the Odoo administrator.
• Keys can be revoked at any time from My Profile → Preferences → API Keys in Odoo.

🧠 Support & Updates

• 📩 Email Support: info@echobitzit.com
• 🕐 Free Support Duration: 365 days from the date of purchase
• 🔄 Lifetime free updates for the same version of the module

© echoBitz IT Solutions Pvt. Ltd.

All rights reserved. Redistribution or sharing of the MCP Server module without authorization is strictly prohibited.