Skip to main content
Glama
wakapi-mcp

wakapi-mcp

by si-essence

wakapi_meta

Read-only

Retrieves Wakapi health, badge, user, and user-agent metadata and returns parameter help for each action.

Instructions

wakapi_meta covers the meta toolset (4 operations). Calls go to WAKAPI_URL with the /api prefix. Authenticated routes send Authorization Basic base64 of the API key. The key is never placed in the URL. Health and shields badges send no key. action help with target returns one action's parameters. Actions: badge, user, user_agents, health.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "action": "<action>"
    },
    "name": "wakapi_meta"
  }
}

Input Schema

NameRequiredDescriptionDefault
bodyNoJSON object or JSON array. Secrets are redacted in output.
queryNoQuery parameters, such as from, to, project, language, and date. Summaries accept format csv.
actionYesWakapi operation to call, or help.
paramsNoPath parameters, such as user, range, interval, filter, and id.
targetNoWith action help, the action whose parameters to describe.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, openWorldHint=true and destructiveHint=false, so the safety profile is covered. The description adds real behavioral context beyond that: calls go to WAKAPI_URL with the /api prefix, authenticated routes use Authorization Basic base64 of the API key, the key is never placed in the URL, and health/shields-badge routes need no key. What is missing is any note on rate limits, error behavior, or response shape.

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

Conciseness4/5

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

The scope statement and action list are front-loaded in the first and last sentences, and each intervening sentence carries a distinct operational fact (URL prefix, auth scheme, unauthenticated routes, help mechanism). It is terse with no filler, though the auth sentences could be tightened into one clause.

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

Completeness4/5

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

For a five-parameter dispatch tool with nested body/query/params objects and no output schema, the definition covers endpoint base, auth requirements, which routes are unauthenticated, and the help-based parameter discovery path. The remaining gap is that per-action semantics and return values are left entirely to the help action, which is a workable but indirect answer.

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?

Schema description coverage is 100%, so the schema already documents action, target, body, query and params, including the examples of path and query keys. The description's only parameter-related statement, that help plus target returns one action's parameters, restates the schema's own target description rather than adding syntax or constraints. Baseline 3 applies when the schema carries the load.

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

Purpose3/5

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

The description names the tool as a multiplexer over a "meta toolset" and enumerates the four actions (badge, user, user_agents, health), which is enough to know it is an action-dispatched tool. However, it never says what any individual action does or returns, so the agent cannot tell what "user" or "user_agents" actually fetch. It also gives no explicit differentiation from siblings like wakapi_heartbeats or wakapi_summaries.

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

Usage Guidelines3/5

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

The only concrete usage rule is "action help with target returns one action's parameters," which is a genuine self-discovery path and implies help should be called first for unfamiliar actions. There is no guidance on when to choose this tool over the sibling tools, and no when-not-to-use conditions.

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