diff --git a/README.md b/README.md index 33eb126..77b402f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ MPM Odoo ERP plugin for Claude Cowork — connects to mpmedia.odoo.com via XML-RPC with proxy-aware transport. -**Version:** 0.1.2 +**Version:** 0.1.3 **Author:** Message Point Media **Repo:** https://git.alwisp.com/jason/odoo-mpm-plugin **CoWork Project:** CW-003 — Odoo V19 MCP Bridge @@ -21,7 +21,7 @@ Credentials are personal — each user authenticates with their own Odoo API key | Skill | What It Does | |---|---| -| `odoo` | Full access to MPM's Odoo instance. Triggers on: "in Odoo", "our products", "the knowledge base", "find a contact", "sales order", "opportunity", "project tasks", "helpdesk ticket", "purchase order", "stock", "inventory", "employee", "what stage is", "create a task", "update the ticket" | +| `odoo` | Full access to MPM's Odoo instance. Triggers on: "in Odoo", "our products", "the knowledge base", "find a contact", "sales order", "opportunity", "project tasks", "helpdesk ticket", "purchase order", "stock", "inventory", "employee", "what stage is", "create a task", "update the ticket", "set icon", "article icon", "emoji icon" | --- @@ -42,11 +42,17 @@ Credentials are personal — each user authenticates with their own Odoo API key | **Employees** | `search_employees`, `get_employee`, `list_departments` | | **Utilities** | `odoo_search`, `odoo_get_record` | +### Knowledge Article Icon Support (v0.1.3) + +`create_knowledge_article` and `update_knowledge_article` both accept an optional `icon` parameter — a single Unicode emoji string (e.g. `"⚙️"`, `"🔌"`, `"🖥️"`) that sets the article's icon in the KB tree view. `get_knowledge_article` now returns the `icon` field. Passing an empty string or omitting the parameter leaves the existing icon unchanged. + +Browse and copy emojis at: **https://emojipedia.org** + --- ## Setup Instructions -Full install guide: [MPM Odoo Plugin — Install Guide](https://docs.google.com/document/d/1t0J_r6IT3OsK5W4hdklizshmZ_yb4S7mMnRoud4BYxA/edit) +Full install guide: [MPM Odoo Plugin — Install Guide](https://docs.google.com/document/d/1t0J_r6IT3OsK5W4hdklizshxmZ_yb4S7mNnRouud4BYxA/edit) **Quick summary:** @@ -82,6 +88,16 @@ Full install guide: [MPM Odoo Plugin — Install Guide](https://docs.google.com/ --- +## Workflow Notes + +- When looking up items by number (e.g. "S00901", "P00195"), use `search_sales_orders` or `search_purchase_orders` with that as the query. +- Before updating a task or ticket stage, call `list_task_stages` or `odoo_search` to confirm valid stage IDs. +- Knowledge article bodies are stored as HTML — use basic HTML formatting when creating or updating. +- When setting KB article icons, browse https://emojipedia.org, copy the emoji character, and pass it to the `icon` parameter. +- IDs returned from search tools can be passed directly to `get_*` tools for full details. + +--- + ## Requirements - Claude Desktop (Cowork mode) @@ -97,6 +113,6 @@ Full install guide: [MPM Odoo Plugin — Install Guide](https://docs.google.com/ |---|---| | MCP server won't start | Confirm `uv` is installed (`which uv`) | | "Credentials not configured" | Run `setup_odoo_credentials` | -| Tool errors on contacts or CRM | Ensure you have v0.1.2 — earlier versions had field compatibility issues | +| Tool errors on contacts or CRM | Ensure you have v0.1.2+ — earlier versions had field compatibility issues | | Keychain prompt on first use | Normal — allow it, credentials are stored securely | | Need to rotate key | Run `clear_odoo_credentials`, generate a new key in Odoo, then run `setup_odoo_credentials` again |