Skip to main content
Glama
wakapi-mcp

wakapi-mcp

by si-essence

wakapi_heartbeats

Read-only

Lists Wakapi heartbeat records to inspect coding activity history, with query filters for user, date range, project, and language.

Instructions

wakapi_heartbeats covers the heartbeats toolset (1 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: list.

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_heartbeats"
  }
}

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

C2.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description adds genuine but generic transport context: calls go to WAKAPI_URL with /api, authenticated routes use Basic base64 of the API key, the key is never in the URL, and health/shields require no key. It says nothing about what a heartbeat record is, filtering defaults, pagination, or volume — behavioral facts the agent would actually need.

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

Conciseness3/5

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

The text is short, but it is front-loaded with boilerplate about WAKAPI_URL, auth headers and shields badges that is largely non-actionable for the caller, while the actual operation name arrives last in "Actions: list." "covers the heartbeats toolset (1 operations)" is awkward and low-information phrasing with a grammar error.

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

Completeness2/5

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

With no output schema, the description should compensate by explaining what a heartbeat list returns and how query filters (from, to, project, language, user) shape it; it does none of that. For a tool with a nested query/params object and a required action, the definition is thin on the things an agent needs to call it correctly beyond authentication trivia.

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 body, query, params, action and target are all documented in the schema itself, making 3 the baseline. The description only restates that "action help with target returns one action's parameters," adding no syntax, format or constraint detail beyond the schema. No incremental semantic value is contributed.

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 identifies the resource family ("the heartbeats toolset") and lists the single available operation ("Actions: list"), so an agent can infer it lists heartbeats. However, the statement of purpose is buried under endpoint and auth boilerplate, and there is no explicit verb+scope statement such as "list coding heartbeats for a user/time range." No sibling differentiation is offered against wakapi_summaries or wakapi_projects.

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

Usage Guidelines2/5

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

There is no when-to-use guidance at all: nothing says when to pick heartbeats over wakapi_summaries (which is the natural alternative for aggregate stats) or when to use action=help vs action=list. The only routing-like statement is "action help with target returns one action's parameters," which explains a mode rather than selection criteria.

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