Update wiki docs with guidance on using MCP tools
Adds clear instructions in root wiki doc explaining: - How to execute actions (use action parameter, NOT service calls) - How to get dropdown options (use moqui_get_screen_details) - How to get action documentation (use moqui_get_help with help URI) - Updated screen paths to use apps/PopcAdmin format - Added global navigation paths (Messages, Tasks, Calendar) This helps models understand how to use the system after we removed service names and dropdown examples from responses.
Showing
1 changed file
with
32 additions
and
23 deletions
| ... | @@ -40,41 +40,50 @@ This server provides access to Moqui ERP through MCP. | ... | @@ -40,41 +40,50 @@ This server provides access to Moqui ERP through MCP. |
| 40 | Use the following discovery tools to explore available functionality: | 40 | Use the following discovery tools to explore available functionality: |
| 41 | - `moqui_browse_screens`: Browse Moqui screen hierarchy | 41 | - `moqui_browse_screens`: Browse Moqui screen hierarchy |
| 42 | - `moqui_search_screens`: Search for screens by name to find their paths | 42 | - `moqui_search_screens`: Search for screens by name to find their paths |
| 43 | - `moqui_get_screen_details`: Get input parameters for specific screens | 43 | - `moqui_get_screen_details`: Get dropdown options and field details |
| 44 | - `moqui_get_help`: Get documentation for actions | ||
| 44 | 45 | ||
| 45 | ## Common Screen Paths | 46 | ## Common Screen Paths |
| 46 | 47 | ||
| 47 | ### Catalog Operations | 48 | ### Catalog Operations |
| 48 | - `/PopCommerce/PopCommerceAdmin/Catalog/dashboard`: Catalog overview and management | 49 | - `apps/PopcAdmin/Catalog/dashboard`: Catalog overview and management |
| 49 | - `/PopCommerce/PopCommerceAdmin/Catalog/Product/FindProduct`: Search and browse products | 50 | - `apps/PopcAdmin/Catalog/Product/FindProduct`: Search and browse products |
| 50 | - `/PopCommerce/PopCommerceAdmin/Catalog/Feature/FindFeature`: Search by features like color or size | 51 | - `apps/PopcAdmin/Catalog/Feature/FindFeature`: Search by features like color or size |
| 51 | - `/PopCommerce/PopCommerceAdmin/Catalog/Product/EditPrices`: View and update product prices | ||
| 52 | 52 | ||
| 53 | ### Order Management | 53 | ### Order Management |
| 54 | - `/PopCommerce/PopCommerceAdmin/Order/FindOrder`: Lookup and create sales/purchase orders | 54 | - `apps/PopcAdmin/Order/FindOrder`: Lookup and create sales/purchase orders |
| 55 | - `/PopCommerce/PopCommerceAdmin/QuickSearch`: General order and customer search | ||
| 56 | 55 | ||
| 57 | ### Party & Customer Management | 56 | ### Party & Customer Management |
| 58 | - `/PopCommerce/PopCommerceAdmin/Party/FindParty`: Manage all parties (People, Organizations) | 57 | - `apps/PopcAdmin/Party/FindParty`: Manage all parties (People, Organizations) |
| 59 | - `/PopCommerce/PopCommerceRoot/Customer`: Customer storefront account management | 58 | - `apps/PopcAdmin/Customer/FindCustomer`: Customer management |
| 60 | - `User`: Internal user account, notifications, and messages | ||
| 61 | - `/PopCommerce/PopCommerceAdmin/QuickSearch`: Customer lookup | ||
| 62 | 59 | ||
| 63 | ### Facility & Accounting | 60 | ### Global Navigation (always available) |
| 64 | - `/PopCommerce/PopCommerceAdmin/Facility/FindFacility`: Manage warehouses and inventory locations | 61 | - `apps/my/User/Messages`: Send and receive messages |
| 65 | - `/PopCommerce/PopCommerceAdmin/Accounting/dashboard`: Financial management and GL accounting | 62 | - `apps/my/User/Notifications`: View notifications |
| 66 | 63 | - `apps/my/User/Task/MyTasks`: Task management | |
| 67 | ### System & Developer Tools | 64 | - `apps/my/User/Calendar/MyCalendar`: Calendar events |
| 68 | - `/tools/Tools`: Developer tools, entity data editing, and service references | ||
| 69 | - `/tools/System`: System administration, cache management, and security settings | ||
| 70 | 65 | ||
| 71 | ## Tips for LLM Clients | 66 | ## Tips for LLM Clients |
| 72 | 67 | ||
| 73 | - All screens support parameterized queries for filtering results | 68 | ### Executing Actions |
| 74 | - Use `moqui_render_screen` with screen path to execute screens | 69 | - Use `moqui_browse_screens` with `action` parameter to execute transitions |
| 75 | - Screen paths use forward slash notation (e.g., `/PopCommerce/PopCommerceAdmin/Catalog/Product`) | 70 | - **Actions are NOT services** - don't try to call service names directly |
| 76 | - Check `moqui_get_screen_details` for required parameters before rendering | 71 | - Example: `moqui_browse_screens(path='...', action='createProduct', parameters={...})` |
| 77 | - Use `renderMode: "mcp"` for structured JSON output or `"text"` for human-readable format]]></fileData> | 72 | |
| 73 | ### Getting Dropdown Options | ||
| 74 | - Dropdown fields show `type: "dropdown"` but not the actual options | ||
| 75 | - Use `moqui_get_screen_details(path='...', fieldName='fieldName')` to get available options | ||
| 76 | - For dependent dropdowns, pass context (e.g., `countryGeoId` for state dropdown) | ||
| 77 | |||
| 78 | ### Getting Action Documentation | ||
| 79 | - Actions include a `help` field like `"help": "wiki:service:ProductAssoc"` | ||
| 80 | - Use `moqui_get_help(uri='wiki:service:ProductAssoc')` to get parameter details | ||
| 81 | - This explains required/optional parameters and valid values | ||
| 82 | |||
| 83 | ### General Tips | ||
| 84 | - Use `renderMode: "compact"` for efficient structured output | ||
| 85 | - Global navigation (Messages, Tasks, Calendar) available in `globalNav` array | ||
| 86 | - Screen paths use forward slash notation: `apps/PopcAdmin/Catalog/Product`]]></fileData> | ||
| 78 | </moqui.resource.DbResourceFile> | 87 | </moqui.resource.DbResourceFile> |
| 79 | 88 | ||
| 80 | <!-- Root Wiki Page --> | 89 | <!-- Root Wiki Page --> | ... | ... |
-
Please register or sign in to post a comment