Skip to main content
Glama
vuluu2k
by vuluu2k

listTopics

Discover available knowledge topics in your GitHub-based knowledge base. Use this tool to see what information exists before reading content.

Instructions

List all knowledge topics. Returns topic names only (no content). Use this first to discover what knowledge exists before reading.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • The implementation of the `listTopics` method within the `KnowledgeBase` class.
    /**
     * List all topic names. 1 API call, no file content read.
     */
    async listTopics(): Promise<string[]> {
      const files = await this.client.listDirectory(this.knowledgePath);
      return files.map((f) => f.replace(/\.md$/, ""));
    }
  • The registration of the `listTopics` tool using `server.registerTool` and the handler logic.
    server.registerTool(
      "listTopics",
      {
        description:
          "List all knowledge topics. Returns topic names only (no content). Use this first to discover what knowledge exists before reading.",
      },
      toolHandler("listTopics", async () => kb.listTopics())
    );
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 burden. It discloses that the tool lists topics and returns only names, which is useful behavioral context. However, it lacks details on potential limitations like pagination, sorting, error conditions, or performance characteristics that would be helpful for a read operation.

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 with zero waste: the first states the purpose and output, the second provides usage guidance. It is front-loaded with the core functionality and efficiently structured.

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?

Given the tool's simplicity (0 parameters, no output schema, no annotations), the description is largely complete. It covers purpose, output format, and usage context. However, without annotations or output schema, additional details on return structure or error handling could enhance completeness for a read operation.

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

Parameters4/5

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

The input schema has 0 parameters with 100% coverage, so no parameter documentation is needed. The description appropriately does not discuss parameters, focusing instead on output semantics ('topic names only'), which adds value beyond the schema. A baseline of 4 is applied for zero-parameter tools.

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 clearly states the specific action ('List all knowledge topics') and resource ('knowledge topics'), distinguishing it from siblings like 'getKnowledge' (which presumably retrieves content) by specifying it returns 'topic names only (no content)'. This provides precise differentiation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly states when to use this tool ('Use this first to discover what knowledge exists before reading'), providing clear guidance on its role as a discovery mechanism prior to content retrieval with alternatives like 'getKnowledge'. This is a direct and helpful usage instruction.

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