SuperAPI AI 工具集

redis-docs-mcp

写作与研究

查看项目

更新于 11-06 01:05

技能介绍

用途

本技能用于指导如何正确使用 redis-docs MCP 服务器。该服务器在 redis.io/mcp 上以 search、fetch、ask 三个工具暴露 redis.io 文档内容。工具自身的描述在「何时调用」上基本准确:先用 search,再 fetch 所需内容,把 ask 留给跨多个领域的问题。本技能补充的是工具描述中写错或未提及的部分。

适用时机:即将通过这些工具查资料;返回结果与工具描述不符;搜索返回空结果,或 ask 被限流、拒绝回答。若同系列其他 Redis 技能已覆盖相关主题,应优先使用它们,因为这些技能带有整理过的指导,原始文档页并不具备。本工具用于核实具体细节和填补空白。

主要能力与索引特点

id 定位的是章节,不是整页

工具描述称 search 返回「页面」、fetch 返回「一个 Redis 文档页」,但索引实际按章节划分,id 有四种形态:

  • 裸页面:如 commands/expire,fetch 返回整页(EXPIRE 约 8.5 KB,含示例与附录)。
  • 命名锚点:如 develop/using-commands/keyspace#sec:key-expiration,返回该章节。
  • 序号窗口:如 develop/ai/search-and-query/advanced-concepts/expiration#sec:w0,返回该窗口(约 1–2 KB)。
  • 锚点加窗口:如 develop/clients/jedis/connect#sec:configure-a-connection-pool-w0,返回该章节的该窗口。

由此可得:同一结果集中重复的 url 不是重复项,多个命中常共享同一页面 url 但 id 不同,应靠片段区分;#sec:wN 序号窗口按相关度排序返回,而非 w0、w1、w2,不要试图用片段拼回整页,直接 fetch 所需章节;绝不自行构造 id,有效 id 只能来自 search 结果或 ask 结果的 sources[].id,猜测对 commands/<name> 偶尔可行,对带章节的 id 一律失败;片段是正文的截断前缀而非摘要,若在关键处被截断,对该 id 执行 fetch 必然包含后续内容,无需换词重搜;引用时应给出页面 url 并在正文中说明章节名,#sec:w1 是索引地址而非网页锚点,带命名锚点的 id 返回的 url 有可用片段,裸 #sec:wN 则没有;返回文本中的链接指向源文件(如 DEL),既非网页 URL 也非 fetch id,不要引用或转换为 id,应改为搜索该词条。

metadata.version 表示「引入于」而非「当前版本」

fetch 返回的 metadata 含 topic、version、section。在 commands/* 页面上,version 是该命令引入的版本,如 commands/setex 为 2.0.0、commands/hexpire 为 7.4.0,仅可用于判断「何时出现」;commands/expire 报告 1.0.0,而正文记载了 2.1.3 的行为变更及 Redis 8 与 Redis Search 的交互。commands/* 之外的字段常不是版本号,例如某个 Redis Search 页面报告的是 stack(产品通道)。因此不要凭 metadata.version 回答「是否在 Redis N 中变更」,应从正文明确表述(如「Before Redis 8…」「since Redis 7.4」)读取并引用。

语料覆盖范围

索引仅限 redis.io,但范围比想象中广:各语言客户端使用指南(如 develop/clients/redis-py/connect#sec:…、develop/clients/jedis/connect#sec:…)、integrate/… 页面、operate/… 下的 Redis Software 与 Redis Cloud 运维文档,以及 Kubernetes operator 生成的 CRD 参考。因此客户端库与企业版问题也应先搜索。

细节常藏在片段之后:搜索 redis-py 的 max_connections 返回 develop/clients/redis-py/async#sec:connection-pools,片段未提及该参数,但 fetch 该章节可查到。若需某库完整签名,应以其 API 参考或源码为准。

不在索引内:GitHub issue 与讨论、包管理页面(PyPI、npm、Maven)、第三方文章。因此应 fetch 相关命中后再下结论,即便如此也只能表述为「在我检索到的结果中未找到」,不可说「redis.io 上没有」或「不存在」。

ask 的调用成本

ask 按 IP 限流,每分钟预算很低,同一 NAT 后的所有人共享,办公室或 CI 运行器可能集体耗尽额度。遇到限流错误应先退避再重试,且一次只问一个窄问题。遇到拒绝时不要换措辞重试;「文档未覆盖此内容」是有依据的结果而非解析失败,应改用 search 加 fetch。可用 ask → sources[].id → fetch 的方式追溯综合答案背后的原始来源。

所有工具的查询文本都会发送到 Redis,ask 的查询还会发送到网关背后的模型提供方,因此尽量使用关于 Redis 命令或行为的通用问题,避免粘贴专有代码。

使用方式

典型流程为:先用 search 检索相关章节,按片段判断命中;对目标 id 执行 fetch 获取完整章节正文;需要跨领域综合回答时再调用 ask,并通过 sources[].id 回查原文。引用时使用页面 url 并说明章节。

适用场景

需要准确检索并引用 Redis 官方文档、核实命令引入版本与行为变更、查询客户端库用法、Redis Software 与 Redis Cloud 运维信息、Kubernetes operator CRD 参考,或排查检索结果异常时。

限制

索引不含 GitHub issue、包管理页面与第三方内容;片段非摘要;id 不可构造;metadata.version 不反映当前版本;ask 限流严格且查询内容会外发。