mcpField
S
search-docs

search-docs

github.com/imagekit-developer开发2488 次安装3 周前更新
代码仓库

关于 search-docs

Documentation Search Skill 指导 Agent 在使用 ImageKit 的 search_docs 工具前准备查询并选择来源，也规定了如何引用搜索结果及处理未解决的问题。

主要功能

  1. 01ImageKit 文档搜索指引
  2. 02将查询改写为具体问题
  3. 03按任务类型选择来源
  4. 04搜索结果引用格式
  5. 05未找到答案时的处理方式

适用场景

  1. 01确认 ImageKit 是否支持某项功能
  2. 02查找 API 或 SDK 细节
  3. 03查询价格与配置说明
  4. 04借助社区来源排查问题

MCP 相关

该技能指导使用 ImageKit 的 search_docs 工具，包括准备查询、选择来源以及引用结果。

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/imagekit-developer/skills --skill search-docs

安装后在 Claude Code 中输入/search-docs确认已加载。

详细介绍

文档搜索技能

按照以下指南准备查询内容并选择来源，然后调用 search_docs，并遵循此处的规则呈现结果。

适用场景

  • 用户询问 ImageKit 的功能、能力或服务
  • 转换构建器失败，需要查询参数或限制信息
  • 用户询问 API、配置、定价或 DAM 功能
  • 需要确认 ImageKit 是否支持某项特定功能
  • 需要查找 SDK 用法示例或 API 参考详情

工具参数

必填：query — 关于 ImageKit 的清晰、具体的问题（参见下文的查询撰写指南）

可选：sources 数组（默认值：["imagekit_guides", "imagekit_community"]）

  • imagekit_guides：官方指南和教程
  • imagekit_community：用户生成的内容和实用方案。非常适合排障和实际用例。
  • imagekit_api_references：技术 API 详情
  • imagekit_sdk：SDK 实现示例

查询撰写指南

规则：调用工具前，始终将用户含糊的问题改写为具体、便于搜索的查询。

用户说不佳的查询（不要传入此查询）优质的查询
“介绍一下 ImageKit”“介绍一下 ImageKit”“ImageKit 功能概览、图像优化和 CDN”
“怎么上传？”“上传”“如何使用 ImageKit 上传 API 上传文件”
“定价信息”“定价”“ImageKit 定价方案和扩展单元费用”
“它能移除背景吗？”“移除背景”“如何使用 ImageKit AI 转换功能移除背景”

来源选择

用例来源
一般功能["imagekit_guides", "imagekit_community"]
API 详情["imagekit_guides", "imagekit_api_references"]
SDK 示例["imagekit_sdk", "imagekit_guides", "imagekit_community"]
排障["imagekit_community", "imagekit_guides"]

Imagekit 社区

  • 提供有价值的实际方案、排障信息和用户体验
  • 可能包含官方指南中没有的实用技巧
  • 始终包含社区来源。它们通常能提供官方文档可能未涵盖的见解和解决方案，尤其适用于排障和实际用例。

处理结果

始终引用来源：

References:
1. [Title]: [URL]

如果结果未能解答问题，请说明这一局限，并建议联系 ImageKit 支持团队。

注意事项

  • 具体的查询效果更好（“如何使用 API 移除背景”，而不是“介绍一下 ImageKit”）
  • 可能需要多次搜索；如果首次搜索结果不够充分，请完善查询
  • 社区来源提供实际方案；官方指南具有权威性

评论

支持 Markdown