Wiki source code of MCP Tools
Last modified by superadmin on 2026/10/14 18:45
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | Everything an AI assistant does on this wiki, it does by calling one of these tools. This page names them, grouped the way the assistant's own catalog is; ##man## documents them. Ask the assistant to call ##man## for the catalog, or ##man <tool>## for one tool's parameters, defaults and limits: that output is generated by the server itself, so it is always current. | ||
| 2 | |||
| 3 | Write tools are off by default and an administrator turns them on per wiki (see [[Enable Write Tools>>doc:documentation.extensions.admin.llm.mcp-server.enable-write-tools.WebHome]]). Whatever is enabled, the assistant acts with your rights and no others (see [[Agent Authentication>>doc:documentation.extensions.user.llm.mcp-server.agent-authentication.WebHome]]). | ||
| 4 | |||
| 5 | == Search and navigation == | ||
| 6 | |||
| 7 | |=Tool |=What it does |=Write | ||
| 8 | |##query_documents## |Search and browse XWiki documents via the wiki's Solr index. |No | ||
| 9 | |##get_document## |Read an XWiki document's content (full, by line range, or outline). |No | ||
| 10 | |##get_tree## |Survey a wiki or explore a subtree as an indented page tree. |No | ||
| 11 | |##get_history## |Read a document's revision history, one revision's content, or a diff. |No | ||
| 12 | |##get_links## |List the pages linking to a document (backlinks), or its own outgoing links. |No | ||
| 13 | |##get_attachment## |Read an attachment's content or metadata from a document. |No | ||
| 14 | |##list_wikis## |List the wikis reachable from this MCP endpoint. |No | ||
| 15 | |||
| 16 | ##list_wikis## exists only where the endpoint has cross-wiki reach. | ||
| 17 | |||
| 18 | == Structured data == | ||
| 19 | |||
| 20 | |=Tool |=What it does |=Write | ||
| 21 | |##query_objects## |Find structured objects (XObjects) by class and field filters. |No | ||
| 22 | |##get_schema## |Describe an XWiki class: its fields and their types, or list all classes with instance counts. |No | ||
| 23 | |##write_object## |Create a structured object or set fields on an existing one (schema-validated). |Yes | ||
| 24 | |##write_schema## |Create or change an XClass definition (add, modify or remove a field). |Yes | ||
| 25 | |##delete_object## |Remove one structured object from a document. |Yes | ||
| 26 | |||
| 27 | == Authoring == | ||
| 28 | |||
| 29 | |=Tool |=What it does |=Write | ||
| 30 | |##edit_document## |Edit a document's content and title by exact string replacement. |Yes | ||
| 31 | |##write_document## |Create a document or replace its entire content. |Yes | ||
| 32 | |##delete_document## |Delete a document (moves it to the recycle bin). |Yes | ||
| 33 | |##write_attachment## |Attach a file to a document, or overwrite an existing attachment. |Yes | ||
| 34 | |##delete_attachment## |Delete an attachment from a document. |Yes | ||
| 35 | |||
| 36 | == Help == | ||
| 37 | |||
| 38 | |=Tool |=What it does |=Write | ||
| 39 | |##man## |Show documentation for the available MCP tools. |No | ||
| 40 | |||
| 41 | ##man## also serves two reference pages: ##man xwiki-syntax## (an XWiki 2.1 syntax cheat-sheet) and ##man awm## (the structure of an App Within Minutes application, and how to build one with the write tools). | ||
| 42 | |||
| 43 | == Semantic search == | ||
| 44 | |||
| 45 | |=Tool |=What it does |=Write | ||
| 46 | |##search_collections## |Semantic + keyword search over indexed collection content. |No | ||
| 47 | |##list_collections## |List the indexed collections available for semantic search. |No | ||
| 48 | |||
| 49 | These two exist only where the AI-LLM indexing module is installed, and they are governed by collection access rights rather than by the wiki's space filter. |