The Miva Knowledge MCP Server gives your AI assistant direct access to Miva’s developer and user documentation. Once it’s connected, assistants like Claude, Cursor and GitHub Copilot look up MivaScript functions, JSON API calls and provisioning tags in the official docs before they answer.
It’s a hosted Model Context Protocol server. There’s nothing to install. Point your client at this URL:
https://knowledge-mcp.miva.com
What’s indexed#
| Area | Examples |
|---|---|
| MivaScript built-in functions (556) | miva_json_decode, substring, crypto_sha256 |
| MivaScript tags (76) | MvIF, MvFOREACH, MvQUERY |
| JSON API functions (281) | Product_Insert, OrderList_Load_Query |
| Module API (70 features) | batchreport, payment, shipping_label |
| LSK functions | AFF_Create_Data_Files, Crypto_SHA256 |
| Provisioning XML | Topics like price groups and custom fields, plus 300+ individual tags such as Category_Add |
| Shadows framework | mmx-* components: properties, MVT templates and JavaScript |
| Developer guides | The rest of docs.miva.com/developer |
| Support articles | Store admin articles from support.miva.com |
Built-ins, tags, JSON API functions and developer guides come from the same source as docs.miva.com. The Module API reference comes from the Module API Reference Guide.
Connect your assistant#
Claude Desktop#
- Open Settings > Connectors.
- Click Add custom connector.
- Name it
Miva Knowledgeand paste the server URL. - Start a new conversation. The tools load automatically.
To set it up by hand instead, add this to claude_desktop_config.json (%APPDATA%\Claude\ on Windows, ~/Library/Application Support/Claude/ on macOS) and restart Claude Desktop:
{
"mcpServers": {
"miva-knowledge-mcp": {
"command": "npx",
"args": ["mcp-remote", "https://knowledge-mcp.miva.com"]
}
}
}
Claude Code#
claude mcp add --transport http miva-knowledge-mcp https://knowledge-mcp.miva.com --scope user
--scope user makes it available in every project. Run /mcp in a session to confirm it’s connected.
Cursor#
Add this to ~/.cursor/mcp.json, or to .cursor/mcp.json in a project:
{
"mcpServers": {
"miva-knowledge-mcp": {
"url": "https://knowledge-mcp.miva.com"
}
}
}
The server shows a green status under Cursor Settings > MCP once it connects.
VS Code (GitHub Copilot)#
Run MCP: Add Server from the Command Palette, choose HTTP and paste the URL. Or add it to your mcp.json directly:
{
"servers": {
"miva-knowledge-mcp": {
"type": "http",
"url": "https://knowledge-mcp.miva.com"
}
}
}
Run MCP: List Servers to confirm it started, then turn the tools on from the tools icon in Copilot Chat.
Other clients#
Any client that supports remote MCP servers over HTTP works with the same URL. For clients that only support local servers, use mcp-remote as in the Claude Desktop example above.
Try it#
Ask your assistant something Miva-specific. If the answer quotes real documentation and links to docs.miva.com or support.miva.com, the connection is working.
- “Write provisioning XML that adds 3 products to the
shirtscategory.” - “Which LSK function loads an order by ID, and what parameters does it take?”
- “Show me the request and response for the
OrderList_Load_QueryJSON API function.” - “How does
MvFOREACHhandle an empty array?” - “What properties does the
mmx-herocomponent have?” - “How do I set up customer-specific pricing in a price group?”
Tools#
Your assistant picks the tool. You don’t need to name it in your prompt.
| Tool | Use |
|---|---|
search_miva_developer_docs |
Searches all indexed docs for open questions. Can be narrowed to one area with doc_type. |
get_builtin_definition |
Looks up a MivaScript built-in function by name. |
get_tag_description |
Looks up a MivaScript tag, with or without brackets. |
get_json_api_function |
Looks up a JSON API function. |
get_module_api_description |
Looks up a Module API feature or function. |
get_lsk_function |
Looks up an LSK function. |
get_provisioning_reference |
Returns provisioning XML reference for a topic or a tag name. |
get_shadows_framework |
Returns the docs, templates and JavaScript for a Shadows component. |
list_available_docs |
Lists the doc categories, how many docs each has and when the data was last updated. |
Lookups by exact name return the full document. When a name isn’t found, the response starts with “No exact match”, lists the 3 closest names and shows the closest document. Your assistant can then retry with the right name.
The doc_type values for search are builtins, language, json_api, module_api, lsk, provisioning, shadows_framework, flex_component, developer_docs and user_docs.
Limits#
- 60 requests per minute per IP address. Over that, the server returns HTTP 429 and asks the client to wait a minute.
- Each response is capped at about 40,000 characters so a single answer doesn’t fill your assistant’s context. Long docs end with a link to the full page. Large Shadows components come back in parts, and your assistant can request the rest.
- Search queries are limited to 500 characters and names to 200.
- Answers are cached for up to 6 hours. A doc updated on docs.miva.com can take that long to show up.
Privacy#
Queries are recorded in shortened, masked form to improve the documentation and kept for up to 3 months. IP addresses are not stored. Don’t include passwords, API keys or customer data in prompts.
Accuracy#
The server returns Miva’s documentation. Your assistant writes the answer, and it can still get things wrong. Check generated code and provisioning XML against the linked source before you use it on a live store.
Troubleshooting#
- Tools don’t show up: restart your client after adding the server. Most clients only load new MCP servers at launch.
- “No exact match” for a name you expected: check the spelling against the closest names in the response, or ask your assistant to search instead. Some functions aren’t documented on docs.miva.com yet.
- “Rate limit exceeded”: wait a minute. If several people share one office IP address, you share the limit too.