README

README.md

@@ -1,3 +1,35 @@
-# odoo-mpm-plugin
+# odoo-mpm
 
-MPM Odoo ERP plugin for Claude Cowork — connects to mpmedia.odoo.com via XML-RPC with proxy-aware transport
+Read-only Odoo ERP plugin for Claude Cowork — connects to MPM's Odoo instance (mpmedia.odoo.com) via XML-RPC with proxy-aware transport.
+
+## Overview
+
+This plugin gives Claude read-only access to MPM's Odoo data. Employees can look up information across all major modules, but cannot create or modify any records.
+
+## Modules & Tools
+
+| Module | Tools |
+|---|---|
+| Products | `search_products`, `get_product`, `get_product_stock` |
+| Knowledge | `search_knowledge_articles`, `get_knowledge_article`, `search_knowledge_templates`, `get_knowledge_template`, `list_knowledge_template_categories` |
+| Contacts | `search_contacts`, `get_contact` |
+| Sales | `search_sales_orders`, `get_sales_order` |
+| CRM | `search_crm_leads`, `get_crm_lead`, `list_crm_stages` |
+| Projects | `list_projects`, `get_project`, `search_tasks`, `get_task`, `list_task_stages` |
+| Helpdesk | `search_helpdesk_tickets`, `get_helpdesk_ticket`, `list_helpdesk_teams` |
+| Purchase | `search_purchase_orders`, `get_purchase_order` |
+| Inventory | `search_inventory`, `get_stock_moves`, `list_internal_locations` |
+| Employees | `search_employees`, `get_employee`, `list_departments` |
+| Utilities | `odoo_search`, `odoo_get_record` |
+
+## Setup
+
+Run `setup_odoo_credentials` once per machine with your Odoo login email and a personal API key. Generate the key in Odoo at **My Profile → Account Security → API Keys → New API Key** (set expiration to "No Limit").
+
+Credentials are stored in the OS keystore (Windows Credential Manager, macOS Keychain, or Linux Secret Service) and never written to disk.
+
+## Requirements
+
+- Python 3.11+
+- [`uv`](https://github.com/astral-sh/uv)
+- Dependencies: `mcp[cli]`, `keyring` (installed automatically via `uv run`)