{"_id":"odoo-devtools-mcp","_rev":"2-5ec405a09615f02b95598b18efe489d9","name":"odoo-devtools-mcp","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.1":{"name":"odoo-devtools-mcp","version":"0.0.1","keywords":["odoo","mcp","modelcontextprotocol","cli","devtools","heliconia","odoo-devtools"],"author":{"url":"https://www.heliconia.io","name":"Heliconia Solutions"},"license":"MIT","_id":"odoo-devtools-mcp@0.0.1","maintainers":[{"name":"atularvind","email":"atul.surficle@gmail.com"}],"homepage":"https://github.com/HeliconiaIO/odoo-devtools-mcp#readme","bugs":{"url":"https://github.com/HeliconiaIO/odoo-devtools-mcp/issues"},"bin":{"odoo-devtools-mcp":"dist/index.js"},"dist":{"shasum":"fdd897d976a6efcbb1ae1c8a5cc53c2eb595431d","tarball":"https://registry.npmjs.org/odoo-devtools-mcp/-/odoo-devtools-mcp-0.0.1.tgz","fileCount":4,"integrity":"sha512-B5hzM0pqGcNMq1wXWIypku2SJrkQQSLIyd3PB3shTFF6M/ds/BsorTdpcAT2TaO+yNRtKowZsWaJrdOzETRd3Q==","signatures":[{"sig":"MEQCIGp5senGpbGMOrNq1y1PsQ35x9UaL+o4UcZIAaez2VWiAiAo/ePyw0kHZDgfy2zg2ieTq00D9f50vFIlUcAWQgZl7w==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":14378},"main":"dist/index.js","type":"module","_from":"file:odoo-devtools-mcp-0.0.1.tgz","engines":{"node":">=18"},"scripts":{"dev":"tsup --watch","eval":"vitest run test/e2e/upgrade.test.ts","test":"vitest run --exclude 'test/e2e/**'","build":"tsup && npm run copy-resources","clean":"rm -rf dist","start":"node dist/index.js","test:e2e":"vitest run test/e2e","typecheck":"tsc --noEmit","test:server":"node scripts/test-server.js","copy-resources":"node scripts/copy-resources.js"},"_npmUser":{"name":"atularvind","email":"atul.surficle@gmail.com"},"_resolved":"/private/var/folders/kw/dbzrrjlx6xggjp6yhj_cn_lh0000gn/T/d2ce7356e085f90d2858f8914e81639d/odoo-devtools-mcp-0.0.1.tgz","_integrity":"sha512-B5hzM0pqGcNMq1wXWIypku2SJrkQQSLIyd3PB3shTFF6M/ds/BsorTdpcAT2TaO+yNRtKowZsWaJrdOzETRd3Q==","repository":{"url":"git+https://github.com/HeliconiaIO/odoo-devtools-mcp.git","type":"git"},"_npmVersion":"10.9.0","description":"CLI to interact with Odoo development tools via the Model Context Protocol (MCP).","directories":{},"_nodeVersion":"20.12.2","dependencies":{"zod":"^4.3.6","node-fetch":"^3.3.2","zod-to-json-schema":"^3.24.1","@modelcontextprotocol/sdk":"^1.26.0"},"_hasShrinkwrap":false,"devDependencies":{"tsup":"^8.5.1","dotenv":"^17.2.3","terser":"^5.46.0","vitest":"^4.0.18","typescript":"^5.9.3","@types/node":"^25.2.0"},"_npmOperationalInternal":{"tmp":"tmp/odoo-devtools-mcp_0.0.1_1770320439887_0.4409852718556402","host":"s3://npm-registry-packages-npm-production"}},"0.0.2":{"name":"odoo-devtools-mcp","version":"0.0.2","type":"module","description":"Model Context Protocol (MCP) server for Odoo development - code generation, analysis tools, security patterns, and workflow automation","main":"dist/index.js","bin":{"odoo-devtools-mcp":"dist/index.js"},"scripts":{"dev":"tsup --watch","copy-resources":"node scripts/copy-resources.js","build":"tsup && npm run copy-resources","prepublishOnly":"pnpm run clean && pnpm run build","clean":"rm -rf dist","start":"node dist/index.js","test":"vitest run --exclude 'test/e2e/**'","test:e2e":"vitest run test/e2e","test:server":"node scripts/test-server.js","eval":"vitest run test/e2e/upgrade.test.ts","typecheck":"tsc --noEmit"},"keywords":["odoo","mcp","modelcontextprotocol","cli","devtools","heliconia","odoo-devtools"],"author":{"name":"Heliconia Solutions","url":"https://www.heliconia.io"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/HeliconiaIO/odoo-devtools-mcp.git"},"bugs":{"url":"https://github.com/HeliconiaIO/odoo-devtools-mcp/issues"},"homepage":"https://github.com/HeliconiaIO/odoo-devtools-mcp#readme","engines":{"node":">=18"},"dependencies":{"@modelcontextprotocol/sdk":"^1.26.0","node-fetch":"^3.3.2","zod":"^4.3.6","zod-to-json-schema":"^3.24.1"},"devDependencies":{"@types/node":"^25.2.0","dotenv":"^17.2.3","terser":"^5.46.0","tsup":"^8.5.1","typescript":"^5.9.3","vitest":"^4.0.18"},"packageManager":"pnpm@9.15.9","_id":"odoo-devtools-mcp@0.0.2","gitHead":"49be21ba5483c17bc7cbb04e9a5bb761f6d7e3cc","_nodeVersion":"20.12.2","_npmVersion":"10.9.0","dist":{"integrity":"sha512-CymTMYT7TRbNXMBP+CUB9tRBhq45nwr+kLvp2pnQxAc/ep1QOiw3r+SvYRrgj6kHiPkyQlM8b92Zvw892IVdDg==","shasum":"284fe6ef14e9a5d780889545fa36568231a0993e","tarball":"https://registry.npmjs.org/odoo-devtools-mcp/-/odoo-devtools-mcp-0.0.2.tgz","fileCount":11,"unpackedSize":127523,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIFDl3TTWLPNvUHXodqnkqId2BPzG2+5zfo7+GAC1fX7FAiBUoOgjwzPDZQKJxI1AILVE6YJzik2HILzwHUtittFI7w=="}]},"_npmUser":{"name":"atularvind","email":"atul.surficle@gmail.com"},"directories":{},"maintainers":[{"name":"atularvind","email":"atul.surficle@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/odoo-devtools-mcp_0.0.2_1770633126230_0.09096220799199806"},"_hasShrinkwrap":false}},"time":{"created":"2026-02-05T19:40:39.805Z","modified":"2026-02-09T10:32:06.477Z","0.0.1":"2026-02-05T19:40:40.042Z","0.0.2":"2026-02-09T10:32:06.355Z"},"bugs":{"url":"https://github.com/HeliconiaIO/odoo-devtools-mcp/issues"},"author":{"name":"Heliconia Solutions","url":"https://www.heliconia.io"},"license":"MIT","homepage":"https://github.com/HeliconiaIO/odoo-devtools-mcp#readme","keywords":["odoo","mcp","modelcontextprotocol","cli","devtools","heliconia","odoo-devtools"],"repository":{"type":"git","url":"git+https://github.com/HeliconiaIO/odoo-devtools-mcp.git"},"description":"Model Context Protocol (MCP) server for Odoo development - code generation, analysis tools, security patterns, and workflow automation","maintainers":[{"name":"atularvind","email":"atul.surficle@gmail.com"}],"readme":"![Odoo-devtools-mcp](https://www.odoophile.com/images/tools/odoo-devtools-mcp.jpg)\n\n# odoo-devtools-mcp\n\n**Model Context Protocol (MCP) server for Odoo development**\n\nConnect AI assistants directly to your Odoo instance for model introspection, field analysis, and development assistance.\n\n![NPM Version](https://img.shields.io/npm/v/odoo-devtools-mcp)\n![Node Current](https://img.shields.io/node/v/odoo-devtools-mcp)\n![NPM Type Definitions](https://img.shields.io/npm/types/odoo-devtools-mcp)\n![NPM Downloads](https://img.shields.io/npm/dy/odoo-devtools-mcp)\n![NPM License](https://img.shields.io/npm/l/odoo-devtools-mcp)\n\n## Features\n\n- 🔌 **Easy Connection** - Connect to any Odoo 16+ instance via JSON-RPC\n- 🔍 **Model Discovery** - Search and explore available models\n- 📊 **Field Introspection** - Get detailed field definitions and relationships\n- 🏗️ **Code Generation** - Generate Python models and XML views\n- 🔄 **Inheritance Explorer** - Visualize model inheritance hierarchies\n- 🎯 **Field Usage Tracking** - Find where fields are used across the codebase\n- ⚠️ **Anti-Pattern Detection** - Identify code quality issues and security risks\n- 📚 **Knowledge Resources** - Access comprehensive Odoo development patterns\n- 🤖 **Workflow Prompts** - Guided workflows for common development tasks\n- 🔑 **Secure** - Support for API key authentication\n- 🚀 **Zero Config** - Works with environment variables\n\n## Quick Start\n\n### 1. Install\n\n```bash\nnpx -y odoo-devtools-mcp@latest\n```\n\n### 2. Configure Your MCP Client\n\nAdd to your MCP client configuration:\n\n**Claude Desktop** (`~/Library/Application Support/Claude/claude_desktop_config.json`):\n\n```json\n{\n  \"mcpServers\": {\n    \"odoo-devtools\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"odoo-devtools-mcp@latest\"],\n      \"env\": {\n        \"ODOO_URL\": \"https://your-instance.odoo.com\",\n        \"ODOO_DB\": \"your-database\",\n        \"ODOO_USERNAME\": \"admin\",\n        \"ODOO_TOKEN\": \"your-api-key\"\n      }\n    }\n  }\n}\n```\n\n**VS Code Copilot** (`.vscode/settings.json`):\n\n```json\n{\n  \"github.copilot.chat.mcp.enabled\": true,\n  \"github.copilot.chat.mcp.servers\": {\n    \"odoo-devtools\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"odoo-devtools-mcp@latest\"],\n      \"env\": {\n        \"ODOO_URL\": \"http://localhost:8069\",\n        \"ODOO_DB\": \"mydb\",\n        \"ODOO_TOKEN\": \"your-api-key\"\n      }\n    }\n  }\n}\n```\n\n> 📚 More configuration examples: [docs/MCP_CONFIG_EXAMPLES.md](docs/MCP_CONFIG_EXAMPLES.md)\n\n### 3. Get Your API Key\n\n1. Log into Odoo → **Settings** → **Users** → Your user\n2. **Account Security** tab → **New API Key**\n3. Copy the generated key\n\n### 4. Start Using\n\nRestart your MCP client and try:\n\n```\nConnect to my Odoo instance and show me all sales models\n```\n\n## Available Tools\n\n### Core Tools\n\n| Tool                      | Description                                            |\n| ------------------------- | ------------------------------------------------------ |\n| **`init`**                | Connect to Odoo instance and establish session         |\n| **`search_models`**       | Search and list models with filters                    |\n| **`get_model_fields`**    | Get detailed field definitions and metadata            |\n| **`detect_odoo_version`** | Detect Odoo version and edition (Community/Enterprise) |\n\n### Code Generation\n\n| Tool                      | Description                                                   |\n| ------------------------- | ------------------------------------------------------------- |\n| **`generate_model_code`** | Generate complete Python model classes with fields            |\n| **`generate_view_xml`**   | Generate XML views (form, tree, search) with smart formatting |\n\n### Analysis Tools\n\n| Tool                        | Description                                                         |\n| --------------------------- | ------------------------------------------------------------------- |\n| **`inheritance_explorer`**  | Explore model inheritance hierarchies (ancestors & descendants)     |\n| **`field_usage_explorer`**  | Find where fields are used in views and code                        |\n| **`anti_pattern_detector`** | Detect security issues, performance problems, and ORM anti-patterns |\n\n## Available Resources\n\nAccess comprehensive Odoo development knowledge:\n\n| Resource                       | Description                                                 |\n| ------------------------------ | ----------------------------------------------------------- |\n| **`odoo://model-patterns`**    | Python model development patterns and best practices        |\n| **`odoo://view-patterns`**     | XML view patterns for form, tree, kanban, search views      |\n| **`odoo://security-patterns`** | Security implementation guide (access rights, record rules) |\n| **`odoo://anti-patterns`**     | Common mistakes and anti-patterns to avoid                  |\n\n## Available Prompts\n\nInteractive guided workflows for common tasks:\n\n| Prompt                      | Description                                    |\n| --------------------------- | ---------------------------------------------- |\n| **`create-custom-module`**  | Step-by-step guide to create a new Odoo module |\n| **`add-field-to-model`**    | Workflow for adding fields to existing models  |\n| **`create-security-rules`** | Setup access rights and record rules           |\n\n### Example Usage\n\n**Model Discovery:**\n\n```\nWhat fields are in the res.partner model?\nShow me all models related to invoicing\nGet the structure of sale.order model\n```\n\n**Code Generation:**\n\n```\nGenerate a Python model for a library management system\nCreate XML views for the product.template model\n```\n\n**Analysis:**\n\n```\nShow me the inheritance hierarchy of sale.order\nWhere is the 'priority' field used in project.task?\nCheck this code for anti-patterns: [paste code]\n```\n\n**Guided Workflows:**\n\n```\nHelp me create a custom module for inventory tracking\nGuide me through adding a new field to res.partner\nShow me how to setup security for my custom model\n```\n\n## Environment Variables\n\n| Variable        | Description                 | Required |\n| --------------- | --------------------------- | -------- |\n| `ODOO_URL`      | Odoo instance URL           | ✅       |\n| `ODOO_DB`       | Database name               | ✅       |\n| `ODOO_TOKEN`    | API key or password         | ✅       |\n| `ODOO_USERNAME` | Username (default: `admin`) |          |\n\n> **Note:** Also supports `ODOO_PASSWORD` and `ODOO_API_KEY` as alternatives to `ODOO_TOKEN`\n\n## Supported Versions\n\n- ✅ **Odoo 16+** (JSON-RPC)\n- ❌ **Odoo 8-15** (not yet supported)\n\n## Documentation\n\n- 📖 [MCP Configuration Examples](docs/MCP_CONFIG_EXAMPLES.md)\n- 🧪 [VS Code Testing Guide](docs/VSCODE_TESTING_GUIDE.md)\n- 🏗️ [Implementation Details](docs/IMPLEMENTATION_SUMMARY.md)\n\n## Troubleshooting\n\n### Connection Failed\n\n- ✅ Verify `ODOO_URL` is correct and accessible\n- ✅ Check database name matches your Odoo instance\n- ✅ Ensure API key/token is valid\n- ✅ Restart your MCP client after config changes\n\n### Tool Not Working\n\n- ✅ Run `init` tool first to establish connection\n- ✅ Check user has access rights to the model\n- ✅ Verify model exists using `search_models`\n\n## Development\n\n```bash\n# Clone and install\ngit clone https://github.com/HeliconiaIO/odoo-devtools-mcp.git\ncd odoo-devtools-mcp\npnpm install\n\n# Build\npnpm build\n\n# Test\npnpm test:server\n```\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines.\n\n## Roadmap\n\n**v0.0.3 (Planned):**\n\n- Record search and data queries\n- Create/update/delete operations\n- Module dependency analyzer\n- Database migration helpers\n\n**Future:**\n\n- View introspection and manipulation\n- Automated testing helpers\n- Performance profiling tools\n- Multi-instance management\n\n## License\n\nMIT © 2026 [Heliconia Solutions](https://www.heliconia.io)\n\n---\n\n**Links:** [GitHub](https://github.com/HeliconiaIO/odoo-devtools-mcp) • [npm](https://www.npmjs.com/package/odoo-devtools-mcp) • [Changelog](CHANGELOG.md)\n","readmeFilename":"README.md"}