MCP Tools
Reference
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.
Write tools are off by default and an administrator turns them on per wiki (see Enable Write Tools). Whatever is enabled, the assistant acts with your rights and no others (see Agent Authentication).
Search and navigation
| Tool | What it does | Write |
|---|---|---|
query_documents | Search and browse XWiki documents via the wiki's Solr index. | No |
get_document | Read an XWiki document's content (full, by line range, or outline). | No |
get_tree | Survey a wiki or explore a subtree as an indented page tree. | No |
get_history | Read a document's revision history, one revision's content, or a diff. | No |
get_links | List the pages linking to a document (backlinks), or its own outgoing links. | No |
get_attachment | Read an attachment's content or metadata from a document. | No |
list_wikis | List the wikis reachable from this MCP endpoint. | No |
list_wikis exists only where the endpoint has cross-wiki reach.
Structured data
| Tool | What it does | Write |
|---|---|---|
query_objects | Find structured objects (XObjects) by class and field filters. | No |
get_schema | Describe an XWiki class: its fields and their types, or list all classes with instance counts. | No |
write_object | Create a structured object or set fields on an existing one (schema-validated). | Yes |
write_schema | Create or change an XClass definition (add, modify or remove a field). | Yes |
delete_object | Remove one structured object from a document. | Yes |
Authoring
| Tool | What it does | Write |
|---|---|---|
edit_document | Edit a document's content and title by exact string replacement. | Yes |
write_document | Create a document or replace its entire content. | Yes |
delete_document | Delete a document (moves it to the recycle bin). | Yes |
write_attachment | Attach a file to a document, or overwrite an existing attachment. | Yes |
delete_attachment | Delete an attachment from a document. | Yes |
Help
| Tool | What it does | Write |
|---|---|---|
man | Show documentation for the available MCP tools. | No |
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).
Semantic search
| Tool | What it does | Write |
|---|---|---|
search_collections | Semantic + keyword search over indexed collection content. | No |
list_collections | List the indexed collections available for semantic search. | No |
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.
