Skip to main content
Glama

search_erispulse_docs

Search ErisPulse framework documentation to find API usage and module development guidance before coding; requires the QvQChat module.

Instructions

检索 ErisPulse 框架文档(写模块/查 API 用法时先查这里再动手;需机器人装有 QvQChat 模块)。

Args: query: 检索关键词(如 "发送消息"、"register_http_route"、"适配器开发") top_k: 最多返回条数(默认 5,最大 20)

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": {
      "query": "<query>"
    },
    "name": "search_erispulse_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
queryYes
top_kNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.9/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It usefully discloses a runtime prerequisite (QvQChat module must be installed) that annotations could not convey, and '检索' implies a read-only retrieval. However, it says nothing about result freshness, whether the doc index must be refreshed first, or the shape of the retrieval results.

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 purpose and the usage trigger are front-loaded in the first parenthetical, followed by a tight Args block; every clause earns its place by adding either a trigger condition, a prerequisite, or parameter meaning. No filler or repetition of the tool name.

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?

With only two parameters, an output schema present, and both parameters described inline, the definition is essentially complete for calling the tool correctly. The only material gap is routing relative to sibling retrieval tools (read_erispulse_doc, refresh_erispulse_docs), which the description never mentions.

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 must compensate, and it does: query is explained as a search keyword with three concrete example queries, and top_k is documented with both a default (5) and a maximum (20). That is nearly all an agent needs, though it doesn't explain matching behavior (exact vs semantic) or what top_k ranks by.

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 a specific verb+resource: search ErisPulse framework documentation (检索 ErisPulse 框架文档), with concrete intent examples (writing modules, checking API usage). It does not distinguish itself from siblings such as read_erispulse_doc or refresh_erispulse_docs, so an agent cannot tell from the text alone when a targeted doc read is preferable to a search.

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 gives clear when-to-use guidance ('写模块/查 API 用法时先查这里再动手' - consult here before acting when writing modules or checking API usage) and a concrete prerequisite (the bot must have the QvQChat module installed). It stops short of naming alternatives or exclusions, e.g. it never says when to use read_erispulse_doc instead.

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