Skip to main content
Glama
ni-c

wikijs-mcp

by ni-c
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Remote

Turn the API on or off

set_api_state
DestructiveIdempotent

Enable or disable all Wiki.js API access instantly. Disabling revokes every API key, including this server's; restore access only via the web admin UI after confirming.

Instructions

Switches Wiki.js’ whole API on or off. Turning it off disables every API key at once, including this server’s — after which the only way back is the web administration UI. Requires a confirmation token.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
enabledYesTrue to enable the API, false to disable it.
confirm_tokenNoToken from this tool’s previous, unconfirmed call. Omit it to receive one.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
truncatedNoPresent only when the answer was shortened to fit the budget.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.2.0
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "additionalProperties": true,
+  "properties": {
+    "truncated": {
+      "additionalProperties": true,
+      "description": "Present only when the answer was shortened to fit the budget.",
+      "properties": {},
+      "type": "object"
+    }
+  },
+  "type": "object"
+}
  2. First observedv0.1.2

TDQS

A4.5/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already mark this as destructive and read-write, but the description adds critical behavioral details: disabling revokes every API key including the caller's, the only recovery path is the web admin UI, and a confirmation token is required. This is exactly the kind of context an agent needs to assess risk before calling.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two sentences with no filler: the main action comes first, followed by the key consequence and then the confirmation requirement. Every clause adds necessary information and the structure is easy to parse.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive two-step toggle, the description covers the action, the consequence, the recovery path, and the confirmation requirement. An output schema exists, so return-value details are not needed. The description is complete enough for safe and correct invocation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema already provides full descriptions for both parameters (100% coverage). The description's mention of 'Requires a confirmation token' largely restates the schema's confirm_token description without adding new semantic meaning. Baseline 3 is appropriate when the schema carries the parameter documentation burden.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb ('Switches') and resource ('Wiki.js’ whole API') with a clear binary outcome (on/off). It is unambiguous and naturally distinguishes itself from all sibling tools, none of which toggle API state.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives clear context for when to use the tool: to enable or disable the entire API. It also warns about the severe consequence of disabling (all API keys invalid, recovery only via web admin UI), which helps an agent decide against casual use. However, it does not explicitly mention alternatives or exclusions, though none exist among siblings.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools