Skip to main content
Glama

flipper_kb_read

Read-onlyIdempotent

Read a saved task-knowledge note by topic slug or title to retrieve relevant recorded guidance for the current task.

Instructions

Read a saved task-knowledge note by topic (slug or title).

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": {
      "topic": "<topic>"
    },
    "name": "flipper_kb_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
topicYes

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so the safety and repeatability profile is fully covered without description help. The description adds only the note that topic may be a slug or a human title. It does not disclose what happens on a missing topic (error versus empty result), which is the main behavioral question left open for a read tool.

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?

One short sentence with the action front-loaded and the parameter clarification in parentheses, so nothing is wasted. It is efficient, but so terse that it omits routing information a caller actually needs.

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

Completeness3/5

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

An output schema exists, so return values need not be explained, and the annotations cover the safety profile. Missing is any statement of what happens when the topic is absent and how to discover valid topics. For a one-parameter read tool that is a noticeable but not fatal gap.

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 0% for the single 'topic' string, so the description must carry meaning, and it does so usefully by clarifying that a slug or a title is accepted. It still says nothing about case sensitivity, formatting, or whether partial titles resolve. This is meaningful compensation but not complete.

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

Purpose4/5

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

States a specific verb (Read) plus a specific resource (saved task-knowledge note) and qualifies the key lookup argument (slug or title). An agent knows exactly what the tool does, but the sentence does not distinguish it from siblings such as flipper_kb_search or flipper_storage_read, so it falls short of a 5.

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 guidance on when to use this tool versus flipper_kb_list or flipper_kb_search, which is the central ambiguity for a keyword-style lookup. The only implied context is 'read one note by topic,' and nothing tells the agent how to handle an unknown or non-existent topic.

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