Manual Search
The Manual Search tool searches and browses the official Mirasvit extension manuals — installation guides, configuration instructions, troubleshooting steps, feature documentation, and per-module changelogs.
Doc Search returns the developer-oriented documentation that modules ship in their etc/mcp/ directory (workflows, API usage, pitfalls). Manual Search returns the end-user manuals published by Mirasvit. Use Manual Search for "how does this feature work / how do I configure it" questions, and to look up a module's changelog.
Access control
Access to this tool is controlled by the MCP Tools -> Built in -> System -> Mirasvit Manuals ACL resource. Enable or disable it in System -> Permissions -> User Roles -> [Role] -> Role Resources.
When to use
- The AI client needs to explain a feature, setting, or behavior that is described in the user manual rather than discoverable through the API.
- Looking up a module's changelog to see what changed between versions.
- Finding which manual covers a given topic.
Actions
The tool has three actions:
list
Returns the catalog of available manuals (metadata only — id, title, package, section count).
| Parameter | Description | Type | Required |
|---|---|---|---|
action | Set to list | string | Yes |
query | Filter manual titles by substring (case-insensitive). Useful when you remember part of a product name. | string | No |
get
Fetches a manual's table of contents, or the full markdown body of one section.
| Parameter | Description | Type | Required |
|---|---|---|---|
action | Set to get | string | Yes |
manual | Manual route (e.g. magento-2-advanced-reports). | string | Yes |
section | Section id (e.g. changelog, getting-started/installation, how-to/custom-report). Omit to get the manual's TOC. | string | No |
search
Runs full-text search across section contents and returns matching snippets ranked by relevance.
| Parameter | Description | Type | Required |
|---|---|---|---|
action | Set to search | string | Yes |
query | Keywords or phrase to match against section contents. | string | Yes |
manual | Limit the search to a single manual (optional scope filter). | string | No |
limit | Maximum number of results (default 10, max 30). | integer | No |
Recommended workflow
- search — find relevant sections by keyword across all manuals.
- get with
manualonly — retrieve the TOC to understand the manual's structure. - get with
manualandsection— read the specific section.
To read a module's changelog, call get with the manual route and section=changelog.