Skip to main content
Glama

List knowledge gaps

list_knowledge_gaps
Read-only

List the knowledge gaps Aide found where its drafts fell short of the replies teammates sent, most conversations first, each with a proposed fix: a new article, an edit to one (change.currentText replaced with change.text), a draft to publish, or text to add to the agent's instructions. Each has its rationale, the article it concerns and how many conversations needed it. Fix one with add_knowledge_article, update_knowledge_article, publish_knowledge_document or update_agent, then mark_knowledge_gap_done.

Input Schema

NameRequiredDescriptionDefault
kindNoOnly gaps whose fix is of this kind.
pageNoPage number, 1 to 500; `metadata.hasMore` says whether another page follows.
statusNoOnly gaps with this status; `open` when omitted.
perPageNoGaps per page (at most 50).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / kind / enum
      Previous value: -[
      -  "topic_create",
      -  "topic_merge",
      -  "topic_split",
      -  "topic_examples",
      -  "scenario_create",
      -  "scenario_edit",
      -  "template_create",
      -  "routing_rule_create",
      -  "field_create",
      -  "knowledge_create",
      -  "knowledge_edit",
      -  "instruction_edit",
      -  "threshold_change",
      -  "tool_request",
      -  "ai_level_change",
      -  "view_create",
      -  "sla_change"
      -]New value: +[
      +  "topic_create",
      +  "topic_merge",
      +  "topic_split",
      +  "topic_examples",
      +  "scenario_create",
      +  "scenario_edit",
      +  "template_create",
      +  "routing_rule_create",
      +  "field_create",
      +  "knowledge_create",
      +  "knowledge_edit",
      +  "instruction_edit",
      +  "threshold_change",
      +  "tool_request",
      +  "ai_level_change",
      +  "view_create",
      +  "sla_change",
      +  "style_edit"
      +]
    • changedInput schema / properties / status / enum
      Previous value: -[
      -  "open",
      -  "applied",
      -  "dismissed",
      -  "snoozed",
      -  "superseded",
      -  "resolved"
      -]New value: +[
      +  "open",
      +  "applied",
      +  "dismissed",
      +  "snoozed",
      +  "superseded",
      +  "resolved",
      +  "reverted"
      +]
  2. Added

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already establish that this is a safe read-only operation, and the description adds useful behavior beyond that: gaps are ordered most-conversations-first, each includes rationale, related article, conversation count, and a proposed fix type. It does not describe pagination or the full response metadata, but the schema covers paging parameters.

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?

The description is front-loaded with the core purpose and then adds the ordering, returned fields, and remediation flow. It is dense but mostly earns its space; the fix-type list and field-replacement detail are useful, though the sentence is packed.

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?

For a read-only listing tool with a rich input schema and no output schema, the description is mostly complete: it explains the gaps, ordering, key returned fields, and next actions. The main remaining gap is that the short fix-type list does not cover all `kind` enum values, which could leave some filter semantics implicit.

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 the baseline is 3. The description adds useful context about what a gap contains and how fixes map to downstream tools, but it does not explain the full 18-value `kind` filter or clarify how its short fix-type list relates to all enum options.

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 states a specific verb and resource: list knowledge gaps where Aide drafts fell short of teammate replies. It also distinguishes this tool from sibling knowledge tools by describing what a gap contains and naming the downstream tools used to fix or close one.

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?

The description gives clear context for when this list is useful and names the resolution path: fix with add_knowledge_article, update_knowledge_article, publish_knowledge_document, or update_agent, then mark_knowledge_gap_done. It does not explicitly compare this listing tool with sibling listing tools or state when not to use it.

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.