Skip to main content
Glama

kb_export

Export knowledge base data to JSON format for backup, transfer, or integration with other systems.

Instructions

Export knowledge base as JSON string

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Tool schema definition with empty input schema and description for exporting knowledge base as JSON.
      name: 'kb_export',
      description: 'Export knowledge base as JSON string',
      inputSchema: {
        type: 'object',
        properties: {}
      }
    },
  • MCP tool handler for 'kb_export' that calls KnowledgeManager.exportKnowledgeBase() and returns the JSON as text content.
    case 'kb_export': {
      const data = await km.exportKnowledgeBase();
      return {
        content: [
          {
            type: 'text',
            text: data
          }
        ]
      };
    }
  • Core implementation of kb_export: serializes the entire knowledge base to formatted JSON string.
    async exportKnowledgeBase(): Promise<string> {
      return JSON.stringify(this.kb, null, 2);
    }
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the tool exports data but doesn't specify whether this is a read-only operation, if it requires permissions, what the export scope is (e.g., all data or filtered), or any side effects like file generation. This leaves significant gaps in understanding the tool's behavior.

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 a single, efficient sentence that directly states the tool's purpose without any fluff or redundancy. It's front-loaded with the core action and resource, making it easy to parse quickly.

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 has 0 parameters and no output schema, the description is minimally complete for a simple export operation. However, it lacks details on behavioral aspects (e.g., export format specifics, error handling) and doesn't differentiate from siblings, which could be important in a server with many knowledge base tools. It's adequate but has clear gaps.

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 tool has 0 parameters, and the input schema has 100% description coverage (though empty). The description doesn't need to explain parameters, so it appropriately focuses on the action and output. A baseline of 4 is applied since no parameters exist, and the description doesn't add unnecessary details.

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 action ('Export') and resource ('knowledge base') with the output format ('as JSON string'), which is specific and unambiguous. However, it doesn't explicitly differentiate from sibling tools like 'kb_import' or 'kb_get_all', which would require a more detailed comparison to achieve a perfect score.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives such as 'kb_get_all' (which might retrieve knowledge base data in a different format) or 'kb_export' versus 'kb_import'. There's no mention of prerequisites, timing, or exclusions, leaving usage context entirely implicit.

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/hlsitechio/mcp-instruct'

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