Skip to main content
Glama

kb_suggest_research

Records a knowledge base gap or missing subject for the owner's research process to review later; call when the KB cannot answer a work need or should cover a recurring topic.

Instructions

Tell the owner's research process about a gap in the knowledge base.

Call this when the knowledge base could not answer something your work needed (kind "gap"), or when a subject the owner's work keeps touching should be in the knowledge base (kind "subject"). One suggestion per gap. Phrase subject as one plain sentence saying what is not yet known. topic is optional (e.g. "AI Engineering", "Running and cardio"); reason and by (who you are, e.g. "claude-code in repo X") are optional too. Suggestions are read by a research process later; nothing is researched now. Do not include secrets or personal data about third parties. Returns {recorded, id, entry}, or {recorded: false, error} if rejected.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
byNo
kindNogap
topicNo
reasonNo
subjectYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.2.1

TDQS

A4.2/5.0
Behavior4/5

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

With no annotations, the description carries the full load and does well: it discloses that this is a deferred, fire-and-forget submission ("Suggestions are read by a research process later; nothing is researched now"), imposes a one-suggestion-per-gap rate discipline, and adds a content restriction (no secrets or third-party personal data). It omits visibility/idempotency details such as whether duplicates are rejected, which keeps it from a 5.

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?

Front-loaded with purpose, then trigger conditions, then parameter guidance, then caveats, then the return shape -- a logical progression with no filler sentences. It is dense but every sentence carries information; only the return-shape line could be trimmed if an output schema existed.

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 5-parameter write tool with no annotations and no output schema, the description covers purpose, triggers, per-parameter meaning, side-effect timing, content constraints, and the success/rejection return shape ({recorded, id, entry} / {recorded: false, error}). Only downstream visibility and duplicate handling are unaddressed.

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

Parameters5/5

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

Schema coverage is 0%, so the description must compensate, and it does: it defines both `kind` values in prose (critical since no enum exists in the schema), gives phrasing instructions for the required `subject`, and names the optional `topic`, `reason`, and `by` with examples including the `by` format ("claude-code in repo X"). There is no parameter left undefined by both schema and description.

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 action and target: record a research suggestion for the owner's research process when the KB has a gap or a missing subject. It is clearly distinct from read-oriented siblings like kb_search and kb_read_page, though it never explicitly contrasts itself with the nearby sibling kb_propose_changes, which an agent might reasonably confuse it with.

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?

Gives two concrete trigger conditions tied to the `kind` values ("could not answer something your work needed" for gap; "a subject the owner's work keeps touching" for subject) and states that nothing is researched now. No explicit when-not-to-use or named alternative tools, so it stops short of a 5.

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