Skip to main content
Glama

kb_report

Read-onlyIdempotent

Health check of the knowledge base: the most connected documents (your core topics), groups that link mostly among themselves, broken links (pointing at documents that do not exist), and documents nothing links to. Run it when tidying up the knowledge base.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "kb_report"
  }
}

Input Schema

NameRequiredDescriptionDefault
limitNoAt most this many broken links and orphans each (default 40)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive, and closed-world, so the safety profile is covered. The description adds useful behavioral substance by spelling out the four analytical sections produced, though it says nothing about cost or that the analysis is computed over the whole base.

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, no filler, with the concrete output list front-loaded ahead of the usage cue. Every clause earns its place.

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?

There is no output schema, so the description's enumeration of returned sections is exactly what an agent needs to judge relevance. Combined with the annotations covering safety, nothing material is missing for a zero-required-parameter analysis tool.

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% and the sole limit parameter is fully documented there, including that it caps broken links and orphans each. The description adds no meaning beyond that, so the baseline 3 applies.

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?

States a specific operation (health check of the knowledge base) and enumerates the exact outputs: most connected documents, self-linking groups, broken links, and orphans. This distinguishes it from graph/search siblings like kb_graph and kb_find without needing to name them.

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?

"Run it when tidying up the knowledge base" gives a clear triggering context. It stops short of exclusions or naming an alternative (e.g., kb_graph for exploring connectivity), so it is a 4 rather than a 5.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources