astrbot-mcp

kb_get

Reads a knowledge base document by ID, source, or URL and returns its content up to a specified character limit.

Instructions

按 ID 或 source 读取一篇知识库文档。

Args: key: 文档 ID、source 或 URL。 max_chars: 正文最大字符数，100-200000。

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "key": "<key>"
    },
    "name": "kb_get"
  }
}

Input Schema

Name	Required	Description	Default
`key`	Yes
`max_chars`	No

Output Schema

Name	Required	Description	Default
`result`	Yes

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.1.0Oct 29, 2026

TDQS

B3.3/5.0

Behavior3/5

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

No annotations exist, so the description carries the full behavioral burden. It does disclose the max_chars truncation limit and its 100-200000 range, which is real behavioral information, but it says nothing about what happens when the key is missing or ambiguous, or whether truncated output is flagged. Adequate but incomplete.

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?

One purpose sentence followed by two compact argument lines, front-loaded with no filler. Slightly terse rather than padded, which is the right failure mode here.

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?

An output schema exists, so return values need not be described, and both parameters are covered. However, a read tool with no annotations and a lookup-style key should say what happens on a miss or an ambiguous match, and how it relates to kb_search; those gaps leave it only minimally complete.

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?

Schema coverage is 0%, so the description must compensate, and it largely does: key is explained as accepting a document ID, source, or URL, and max_chars is given a meaning plus an explicit range. Only the default value (20000) is left to the schema.

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 and resource: read a knowledge base document by ID or source. It does not distinguish itself from kb_search or kb_list, which an agent could easily confuse it with, so it falls short of a 5.

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?

No statement of when to use this rather than kb_search (find a document) or kb_list (enumerate documents). The phrase 'by ID or source' weakly implies the caller already holds an identifier, but no alternative is named and no exclusion is given.

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