Skip to main content
Glama

fixflow

by io.github.MagneticDogSon

read_kb_doc

SECOND STEP in the troubleshooting workflow. Read the full content and solution of a specific Knowledge Base card.

Returns the card content WITH reliability metrics and related cards so you can assess trustworthiness and explore connected issues.

WHEN TO USE:

  • Call this ONLY after obtaining a valid kb_id from the resolve_kb_id tool.

INPUT:

  • kb_id: The exact ID of the card (e.g., 'CROSS_DOCKER_001').

OUTPUT:

  • Returns reliability metrics followed by the full Markdown content of the card, plus related cards.

  • You MUST apply the solution provided in the card to resolve the user's issue.

  • After applying, you MUST call save_kb_card with outcome parameter to close the feedback loop.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
kb_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

With no annotations, the description carries the transparency burden. It discloses the return format (reliability metrics, full Markdown content, related cards) and imposes mandatory behavioral requirements (apply the solution and call save_kb_card). It does not address error handling or invalid IDs, but the disclosed behaviors are significant and go beyond the basic read action.

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?

The description is organized into clear sections (WHEN TO USE, INPUT, OUTPUT) with front-loaded workflow context. Every sentence adds value, such as the reliability metrics detail and the mandatory follow-up, without excessive redundancy.

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?

The description covers the tool's role in the workflow, the input requirement, the output structure, and the required follow-up action. Given the existing output schema and single parameter, it is sufficiently complete, though it could include error-handling details.

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

Parameters4/5

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

The input schema has zero description coverage for kb_id, but the tool description compensates by defining it as 'the exact ID of the card' and providing an example format ('CROSS_DOCKER_001'), giving the agent the necessary semantic context.

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 clearly states 'Read the full content and solution of a specific Knowledge Base card' with a specific verb and resource. The 'SECOND STEP' positioning and references to sibling tools (resolve_kb_id, save_kb_card) distinguish it from the others.

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

Usage Guidelines5/5

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

Explicitly states 'Call this ONLY after obtaining a valid kb_id from the resolve_kb_id tool,' establishing a clear prerequisite. The output section also mandates following up with save_kb_card, giving a complete workflow ordering.

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

All fixflow toolsInspect
Try in Browser
RayrunBuild, deploy, and operate MCP servers without becoming an infrastructure team.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4.8/5.0
Disambiguation5/5

Each tool has a distinct role in the troubleshooting workflow: resolve_kb_id searches, read_kb_doc retrieves a specific card, and save_kb_card writes or reports outcomes. There is no overlap in their purposes.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern: resolve_kb_id, read_kb_doc, save_kb_card. The verbs clearly indicate the action taken on the knowledge base.

Tool Count5/5

Three tools perfectly cover the search-read-write lifecycle of a knowledge base. The count is well-scoped for the server's specific purpose, avoiding unnecessary bloat.

Completeness5/5

The toolset provides complete coverage for the stated workflow: search, read full content, save new cards, and report outcomes. The overwrite option in save_kb_card also supports updates, closing the loop.

Resources