docs: document icon field support in Knowledge article tools
This commit is contained in:
+42
-3
@@ -8,26 +8,62 @@ description: >
|
|||||||
employees and departments. Triggers on: "in Odoo", "our products", "the
|
employees and departments. Triggers on: "in Odoo", "our products", "the
|
||||||
knowledge base", "find a contact", "sales order", "opportunity", "project
|
knowledge base", "find a contact", "sales order", "opportunity", "project
|
||||||
tasks", "helpdesk ticket", "purchase order", "stock", "inventory",
|
tasks", "helpdesk ticket", "purchase order", "stock", "inventory",
|
||||||
"employee", "what stage is", "create a task", "update the ticket".
|
"employee", "what stage is", "create a task", "update the ticket",
|
||||||
|
"set icon", "article icon", "emoji icon".
|
||||||
---
|
---
|
||||||
|
|
||||||
# Odoo MPM Skill
|
# Odoo MPM Skill
|
||||||
|
|
||||||
You have direct access to MPM's Odoo V18 instance at mpmedia.odoo.com via the `odoo-mpm` MCP server.
|
You have direct access to MPM's Odoo V19 instance at mpmedia.odoo.com via the `odoo-mpm` MCP server.
|
||||||
|
|
||||||
|
## First-Time Setup (required once per Mac)
|
||||||
|
|
||||||
|
Each team member connects using their own personal Odoo credentials. Credentials are stored securely in the macOS Keychain — never in a file on disk.
|
||||||
|
|
||||||
|
**Step 1 — Generate your Odoo API key**
|
||||||
|
|
||||||
|
1. Open [mpmedia.odoo.com](https://mpmedia.odoo.com) and log in with your account
|
||||||
|
2. Click your avatar (top-right corner) → **My Profile**
|
||||||
|
3. Go to the **Account Security** tab
|
||||||
|
4. Under **API Keys**, click **New API Key**
|
||||||
|
5. Enter a label such as `Claude Cowork`
|
||||||
|
6. Set the **Expiration** to **No Limit** (indefinite — the key should not expire)
|
||||||
|
7. Click **Generate Key** and copy it immediately — Odoo only displays it once
|
||||||
|
|
||||||
|
**Step 2 — Store your credentials**
|
||||||
|
|
||||||
|
Run the `setup_odoo_credentials` tool:
|
||||||
|
- `username`: your Odoo login email (e.g. `you@mpmedia.tv`)
|
||||||
|
- `api_key`: the key you just copied
|
||||||
|
|
||||||
|
The tool will save your credentials to the macOS Keychain and immediately verify the connection. You will not need to do this again unless you rotate your key or get a new Mac.
|
||||||
|
|
||||||
|
**Troubleshooting auth issues:** run `clear_odoo_credentials` then `setup_odoo_credentials` again with a freshly generated key.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Connection Details
|
## Connection Details
|
||||||
- Instance: mpmedia.odoo.com
|
- Instance: mpmedia.odoo.com
|
||||||
- Database: mpmedia-odoo-sh-main-13285275
|
- Database: mpmedia-odoo-sh-main-13285275
|
||||||
- User context: Bryan Gilliom (System Administrator)
|
- User context: your personal Odoo account
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Available Modules & Tools
|
## Available Modules & Tools
|
||||||
|
|
||||||
|
### Credentials (`setup_odoo_credentials`, `clear_odoo_credentials`)
|
||||||
|
One-time setup to store your personal API key in the macOS Keychain. Use `clear_odoo_credentials` when rotating your key or offboarding.
|
||||||
|
|
||||||
### Products (`search_products`, `get_product`, `get_product_stock`)
|
### Products (`search_products`, `get_product`, `get_product_stock`)
|
||||||
Search the product catalog, retrieve product details including pricing and descriptions, and check stock levels across warehouse locations.
|
Search the product catalog, retrieve product details including pricing and descriptions, and check stock levels across warehouse locations.
|
||||||
|
|
||||||
### Knowledge (`search_knowledge_articles`, `get_knowledge_article`, `create_knowledge_article`, `update_knowledge_article`)
|
### Knowledge (`search_knowledge_articles`, `get_knowledge_article`, `create_knowledge_article`, `update_knowledge_article`)
|
||||||
Read, search, create, and update internal Knowledge base articles. Body content is HTML.
|
Read, search, create, and update internal Knowledge base articles. Body content is HTML.
|
||||||
|
|
||||||
|
**Icon support:** Both `create_knowledge_article` and `update_knowledge_article` 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` returns the current icon. Omitting or passing an empty string leaves the existing icon unchanged.
|
||||||
|
|
||||||
|
To browse and select emojis, use: **[Emojipedia](https://emojipedia.org)** — search by keyword, copy the emoji character, and pass it directly to the tool.
|
||||||
|
|
||||||
### Contacts (`search_contacts`, `get_contact`, `create_contact`)
|
### Contacts (`search_contacts`, `get_contact`, `create_contact`)
|
||||||
Search customers, vendors, and individuals. Use `is_company=true` to filter to companies.
|
Search customers, vendors, and individuals. Use `is_company=true` to filter to companies.
|
||||||
|
|
||||||
@@ -55,10 +91,13 @@ Look up employee information and department structure.
|
|||||||
### Utilities (`odoo_search`, `odoo_get_record`)
|
### Utilities (`odoo_search`, `odoo_get_record`)
|
||||||
Generic tools for any Odoo model — useful for looking up stage IDs, categories, or any other reference data.
|
Generic tools for any Odoo model — useful for looking up stage IDs, categories, or any other reference data.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Workflow Guidelines
|
## Workflow Guidelines
|
||||||
|
|
||||||
- When looking up items by number (e.g. "S00901", "P00195"), use `search_sales_orders` or `search_purchase_orders` with that as the query.
|
- 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('helpdesk.stage', 'name', ...)` to confirm valid stage IDs.
|
- Before updating a task or ticket stage, call `list_task_stages` or `odoo_search('helpdesk.stage', 'name', ...)` to confirm valid stage IDs.
|
||||||
- Knowledge article bodies are stored as HTML — when creating or updating articles, use basic HTML formatting.
|
- Knowledge article bodies are stored as HTML — when creating or updating articles, use basic HTML formatting.
|
||||||
|
- When setting KB article icons, prompt the user for the emoji or suggest one based on context. Reference: https://emojipedia.org
|
||||||
- IDs returned from search tools can be passed directly to `get_*` tools for full details.
|
- IDs returned from search tools can be passed directly to `get_*` tools for full details.
|
||||||
- When the user asks about "our products" without specifying, use `search_products` with no query and limit=20 to show a broad overview.
|
- When the user asks about "our products" without specifying, use `search_products` with no query and limit=20 to show a broad overview.
|
||||||
|
|||||||
Reference in New Issue
Block a user