Skip to main content
Glama

Knowledge gaps

knowledge_gaps
Read-only

Identify content gaps by surfacing unanswered 'ask your docs' questions, providing a content roadmap to improve documentation coverage.

Instructions

The most-asked "ask your docs" questions the corpus could NOT answer — a content roadmap. Instance-admin only (exposes users' questions). Optional since_days window.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNomax gaps (default 50)
since_daysNoonly count asks in the last N days (0 = all time)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
gapsYes
Behavior4/5

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

Annotations already declare readOnlyHint and destructiveHint. The description adds that it exposes users' questions and is admin-only, which are behavioral traits beyond annotations (privacy/access).

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: first defines the tool's purpose, second adds access constraint and optional parameter. No wasted words, front-loaded.

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?

Tool has an output schema, no required params, simple behavior. Description fully covers what the tool does, its access restrictions, and the optional time window. Complete for this use case.

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 coverage is 100% with detailed descriptions for both parameters (limit and since_days). The description only mentions 'Optional since_days window' which doesn't add new meaning beyond the schema. Baseline 3.

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?

Description clearly states it returns 'the most-asked ask your docs questions the corpus could NOT answer — a content roadmap.' This is a specific verb+resource, and the purpose is distinct from sibling tools like list_pages or search.

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 notes 'Instance-admin only (exposes users' questions)' and 'Optional since_days window,' providing clear context and parameter guidance. No explicit alternatives or when-not-to-use, but adequate.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/zcag/tela'

If you have feedback or need assistance with the MCP directory API, please join our Discord server