Skip to main content
Glama

knowledge

Read the project's reference base: call with no topic to list topics, or provide a topic to retrieve its details.

Instructions

Read the project's knowledge base. Call with no topic to list topics.

Input Schema

NameRequiredDescriptionDefault
topicNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.8/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full disclosure burden. It does reveal the dual-mode behavior (omit topic to enumerate topics, supply topic to read) that the schema does not express, but it never says what a read returns, how unknown topics fail, or whether the knowledge base is large enough to need paging.

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 short imperative sentences with no filler, and the primary action is front-loaded ahead of the optional-argument hint. Every sentence earns its place.

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 one-optional-parameter read tool with no output schema and no annotations, the description covers the essential calling contract, including the no-argument mode. Only failure behavior for invalid topics is left unaddressed.

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%, so the description must compensate for the undocumented 'topic' parameter. It partially does by explaining the omitting-topic case, implying topic is a selector, but it gives no format, case sensitivity, or valid-value examples for a free-string parameter.

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) and resource (the project's knowledge base), which is more than the bare name 'knowledge' conveys. It does not reference any sibling, but the surrounding siblings (probe, conform, chroma_key, colmap_solve) are all media-pipeline tools, so there is no plausible confusable alternative to differentiate against.

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 one concrete calling rule: 'Call with no topic to list topics,' which tells the agent how to discover valid input before reading. It stops short of saying when to prefer this tool over other discovery routes or what to do on an unknown topic, but for a single-parameter tool the guidance is actionable.

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