Wiki source code of Tool Policies
Last modified by gabrielc on 2026/10/21 10:53
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | Default policies for tool enablement per wiki and special tool categories. | ||
| 2 | |||
| 3 | When the ##enabledTools## list is empty (the default after installation), every non-write tool is enabled and every write tool is off: | ||
| 4 | |||
| 5 | |=Category |=Tools |=Enabled by default | ||
| 6 | |Help |##man## |Always (mandatory) | ||
| 7 | |Search & Navigation |##query_documents##, ##get_document##, ##get_tree##, ##get_history##, ##get_links##, ##get_attachment## |Yes | ||
| 8 | |Structured Data (read) |##query_objects##, ##get_schema## |Yes | ||
| 9 | |Authoring (write) |##edit_document##, ##write_document##, ##delete_document##, ##write_attachment##, ##delete_attachment## |No | ||
| 10 | |Structured Data (write) |##write_object##, ##delete_object##, ##write_schema## |No | ||
| 11 | |Reach-gated |##list_wikis## |Only when cross-wiki reach is enabled | ||
| 12 | |||
| 13 | == Mandatory tools == | ||
| 14 | |||
| 15 | ##man## is always registered regardless of the enabled tools list. It provides self-documentation and costs nothing. | ||
| 16 | |||
| 17 | == Write tools == | ||
| 18 | |||
| 19 | Tools where ##isWrite() == true## are off by default and must be enabled by an administrator per wiki. Eight tools are write tools, covering page content and deletion, attachments, structured objects and class definitions. See [[Enable Write Tools>>doc:documentation.extensions.admin.llm.mcp-server.enable-write-tools.WebHome]]. | ||
| 20 | |||
| 21 | A write tool is never served to a guest caller: the guest variant of the server does not register it, and a call that still reaches one is refused before it runs. Contributed tools follow the same rule. The default of ##isWrite()## is false, so a contributed tool that writes must declare it, both to stay off by default and to stay away from guests. | ||
| 22 | |||
| 23 | == Reach-gated tools == | ||
| 24 | |||
| 25 | ##list_wikis## is registered only when the endpoint has cross-wiki reach. It is not shown in the admin tool checkbox tree: reach is its enable switch. | ||
| 26 | |||
| 27 | == Tool categories == | ||
| 28 | |||
| 29 | The category is the tool's own category value, and it drives the grouping of the ##man## catalog. | ||
| 30 | |||
| 31 | |=Category |=Tools | ||
| 32 | |Help |##man## | ||
| 33 | |Search & Navigation |##query_documents##, ##get_document##, ##get_tree##, ##get_history##, ##get_links##, ##get_attachment##, ##list_wikis## (reach-gated) | ||
| 34 | |Structured Data |##query_objects##, ##get_schema##, ##write_object##, ##delete_object##, ##write_schema## | ||
| 35 | |Authoring |##edit_document##, ##write_document##, ##delete_document##, ##write_attachment##, ##delete_attachment## | ||
| 36 | |||
| 37 | == Collection tools (index module) == | ||
| 38 | |||
| 39 | When the AI-LLM indexing module is installed, two additional tools are available: | ||
| 40 | |||
| 41 | |=Tool |=Category | ||
| 42 | |##search_collections## |Semantic Search | ||
| 43 | |##list_collections## |Semantic Search | ||
| 44 | |||
| 45 | These tools are governed by collection access rights, not the space filter. Neither declares itself as a write tool, so both are part of the default policy and enabled by default. |
