Skip to main content
Glama
vuluu2k
by vuluu2k

getKnowledge

Retrieve structured knowledge entries from a specific topic to access organized information from a version-controlled repository.

Instructions

Get all entries from a specific knowledge topic. Use listTopics first to see available topics.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topicYesTopic name (e.g. typescript, docker, project-setup)

Implementation Reference

  • The core logic for retrieving knowledge, which fetches the topic file and parses it into entries.
    async getTopic(topic: string): Promise<{ topic: string; entries: KnowledgeEntry[] }> {
      const file = await this.client.getFile(this.topicPath(topic));
      return { topic, entries: parseEntries(file.content) };
    }
  • Registration of the 'getKnowledge' tool with the MCP server, mapping it to the 'getTopic' handler.
    server.registerTool(
      "getKnowledge",
      {
        description:
          "Get all entries from a specific knowledge topic. Use listTopics first to see available topics.",
        inputSchema: {
          topic: z.string().describe("Topic name (e.g. typescript, docker, project-setup)"),
        },
      },
      toolHandler("getKnowledge", async ({ topic }) => kb.getTopic(topic))
    );
Behavior2/5

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

No annotations are provided, so the description carries the full burden. It states it 'Get all entries' but doesn't disclose behavioral traits such as whether this is a read-only operation, potential rate limits, authentication needs, or what 'all entries' entails (e.g., pagination, format). This leaves significant gaps for a tool with no annotation coverage.

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?

The description is two sentences, front-loaded with the core purpose and followed by a practical usage tip. Every sentence earns its place with no wasted words, making it efficient and easy to parse.

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?

Given the tool's low complexity (1 parameter, no output schema, no annotations), the description is somewhat complete but lacks details on behavioral aspects like response format or constraints. It covers basic usage but doesn't fully compensate for the absence of annotations, making it adequate but with clear gaps.

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?

The input schema has 100% description coverage, with the 'topic' parameter well-documented. The description adds minimal value by implying the topic must be from 'listTopics', but doesn't provide additional semantics beyond what the schema already covers, meeting the baseline for high schema coverage.

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?

The description clearly states the verb 'Get' and resource 'entries from a specific knowledge topic', making the purpose understandable. However, it doesn't explicitly differentiate from sibling tools like 'searchKnowledge' or 'getNotes', which might also retrieve knowledge-related data, leaving some ambiguity about uniqueness.

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?

It provides explicit guidance to 'Use listTopics first to see available topics', which is helpful for context. But it doesn't specify when to use this tool versus alternatives like 'searchKnowledge' or 'getNotes', missing clear differentiation from siblings.

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/vuluu2k/knowledge_mcp'

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