Skip to main content
Glama

Read knowledge gap

knowledge_gap_read
Read-onlyIdempotent

Reads scoped original retained question by ID, including older questions.

Input Schema

NameRequiredDescriptionDefault
gap_idYesRetained question ID from knowledge_gaps_list or workspace_knowledge_gaps.
agent_idYesAgent ID from agents_list or agent_create.

Output Schema

NameRequiredDescriptionDefault
idYes
bot_idYes
handoffYes
asked_atYes
bot_nameYes
questionYes
conversation_idNo
question_message_idNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • removedOutput schema / description
      Removed value: -"One retained unanswered question, without similarity grouping or inferred counts."
    • changedOutput schema / title
      Previous value: -"WorkspaceKnowledgeGap"New value: +"PublicWorkspaceKnowledgeGap"
  2. Changed2 schema fields changed
    • addedInput schema / properties / agent_id / description
      Added value: +"Agent ID from agents_list or agent_create."
    • addedInput schema / properties / gap_id / description
      Added value: +"Retained question ID from knowledge_gaps_list or workspace_knowledge_gaps."
  3. First observed

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered structurally. The description adds one useful behavioral detail -- that older questions are included in what is returned -- but says nothing about scoping semantics beyond the word 'scoped'.

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?

A single front-loaded sentence with no filler, and the key scope qualifier ('including older questions') is stated immediately. Minor cost from the compressed, slightly awkward noun stack 'scoped original retained question'.

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 described, and annotations cover safety, leaving a low burden. However, for a read tool whose payload is conceptually unusual ('retained question'), the description does not explain what a retained question is or what 'scoped' means for the agent_id, leaving a residual ambiguity.

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%, with both gap_id and agent_id documented (including where the IDs come from), so the baseline is 3. The description's 'scoped' and 'by ID' phrases reinforce the two-parameter lookup but add no meaning beyond the schema.

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 ('Reads') and resource ('scoped original retained question by ID'), which distinguishes it from the plural list siblings such as knowledge_gaps_list. The phrasing 'original retained question' is somewhat jargon-heavy, but the single-record-by-ID purpose is unambiguous.

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?

The description gives no explicit when-to-use guidance or alternatives; it never names knowledge_gaps_list or workspace_knowledge_gaps as the way to obtain a gap_id. The only routing hints live in the input schema's parameter descriptions, not in the description itself.

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