MCP Tools

Last modified by gabrielc on 2026/10/20 17:06

Reference

Everything an AI assistant does on this wiki, it does by calling one of these tools. This page names the tools, grouped the way the assistant's own catalog is, and lists the catalog's reference pages; man documents both. 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, an assistant that has signed in acts with your rights and no others, and an assistant served as a guest never receives a write tool (see Agent Authentication).

Authoring

Tool What it does Write
delete_attachment Delete an attachment from a document. Yes
delete_document Delete a document (moves it to the recycle bin). Yes
edit_document Edit a document's content and title by exact string replacement. Yes
write_attachment Attach a file to a document, or overwrite an existing attachment. Yes
write_document Create a document or replace its entire content. Yes

Help

Tool What it does Write
man Show documentation for the available MCP tools. No

man is always available, even when an administrator has turned every other tool off. For a guest caller it lists only the read tools and the reference pages.

Reference

The catalog's Reference section documents the syntax and structures the write tools produce.

Reference page What it covers
awm The structure of an App Within Minutes application, and how to build one with the write tools.
xwiki-syntax An XWiki 2.1 syntax cheat-sheet.

Search & Navigation

Tool What it does Write
get_attachment Read an attachment's content or metadata from a document. No
get_document Read a document's source (full, by line range, or outline), or its rendered output as plain text or HTML. 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_tree Survey a wiki or explore a subtree as an indented page tree. No
list_wikis List the wikis reachable from this MCP endpoint. No
query_documents Search and browse XWiki documents via the wiki's Solr index. No

Searches and tree reads leave hidden pages out unless the caller asks for them; get_links counts hidden backlinks without listing them by default. get_document returns the source by default and its rendered output only when asked.

list_wikis appears only where the endpoint has cross-wiki reach; it is not part of the tool selection.

Semantic Search

Tool What it does Write
list_collections List the indexed collections available for semantic search. No
search_collections Semantic + keyword search over indexed collection content. 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.

Structured Data

Tool What it does Write
delete_object Remove one structured object from a document. Yes
get_schema Describe an XWiki class: its fields and their types, or list all classes with instance counts. No
query_objects Find structured objects (XObjects) by class and field filters. No
write_object Create a structured object or set fields on an existing one (type-checked: the field must exist and number, date and boolean values must parse). Yes
write_schema Create or change an XClass definition (add, modify or remove a field). Yes

Related

Get Connected