Skip to main content
Glama

read_erispulse_doc

Reads a documentation file's full text using its relative path from search results and returns up to a set character limit.

Instructions

读取框架文档单文件全文(路径来自 search_erispulse_docs 结果的 file 字段)。

Args: file: 文档相对路径(相对文档根目录) limit: 最多返回字符数(默认 8000)

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": {
      "file": "<file>"
    },
    "name": "read_erispulse_doc"
  }
}

Input Schema

NameRequiredDescriptionDefault
fileYes
limitNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are supplied, so the description must carry the full disclosure. It does reveal one behavioral trait beyond the schema: the limit argument truncates the returned content at 8000 characters by default. It does not say how a missing or invalid path is handled, whether truncation is signaled, or what types of files are supported.

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?

The description is short and front-loaded: it states the action first, then lists the arguments. The Args block repeats what the schema already shows for limit, but the added default and unit information justifies it.

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 simple two-parameter read tool with an output schema, this is nearly complete: purpose, argument meanings, and truncation behavior are covered, and return values need not be explained. The remaining gap is error and edge-case behavior for invalid or non-text files.

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 description coverage is 0%, so the description has to define both parameters, and it does: file is a relative path to the documentation root, and limit is a maximum character count defaulting to 8000. The only gap is that the link between file and the 'file' field name from search results is stated in the intro rather than with the argument.

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 gives a specific verb and resource: read the full text of a single framework documentation file. It also ties the file argument to the 'file' field returned by search_erispulse_docs, which distinguishes it from that sibling's search behavior.

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

Usage Guidelines3/5

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

Usage is only implied by the note that the path comes from search_erispulse_docs results, which suggests a search-then-read workflow. There is no explicit statement of when to choose this tool over call_module or get_module_info, and no exclusion for non-documentation paths.

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