mcpField
A
add-neon-docs

add-neon-docs

github.com/neondatabaseAgent 工作流86152 次安装39 周前更新
代码仓库

关于 add-neon-docs

此 skill 将 Neon 文档链接添加到项目的 AI 文档文件,供 AI 助手查阅特定主题的指南,无需将大型文档复制到项目中。

主要功能

  1. 01检测受支持的 AI 文档文件
  2. 02修改前征求确认
  3. 03将链接添加到参考资料部分
  4. 04必要时创建 CLAUDE.md

适用场景

  1. 01配置 Neon 后添加最佳实践链接
  2. 02在 AI 项目文档中关联相关 Neon 指南

安装

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

$npx skills add https://github.com/neondatabase/ai-rules --skill add-neon-docs

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

附带文件install-knowledge.mdskill-knowledge-map.json

详细介绍

向项目添加 Neon 知识参考

此技能会在项目的 AI 文档文件中添加指向 Neon 文档和最佳实践的参考链接,让 AI 助手能够快速获取 Neon 专属模式和指南,同时避免在项目中堆积大型文档文件。

工作原理

此技能遵循简单的工作流程:

  1. 加载元数据 - 从 skill-knowledge-map.json 读取技能信息
  2. 检测文档文件 - 查找 CLAUDE.md、AGENTS.md 或 Cursor 规则文件
  3. 征求许可 - 显示将添加的内容及其位置
  4. 添加参考链接 - 在“Resources & References”部分插入 URL
  5. 报告完成情况 - 确认安装成功

如需查看详细的工作流程步骤,请参阅 install-knowledge.md。

参数

SKILL_NAME 参数

可选。指定要安装的技能文档(例如 "neon-drizzle")。如果未提供,系统会提示你从 skill-knowledge-map.json 中定义的可用技能里进行选择。

使用示例

由其他技能调用:

Execute the add-neon-docs skill with SKILL_NAME="neon-drizzle"

由用户直接调用:

  • “将 Neon drizzle 知识添加到我的项目中”
  • “安装 Neon 无服务器文档”
  • “为我的 AI 助手设置 Neon 最佳实践”

添加的内容

参考链接会添加到 AI 文档文件中的“Resources & References”部分:

## Resources & References

- **Neon and Drizzle ORM best practices**: https://raw.githubusercontent.com/neondatabase-labs/ai-rules/main/neon-drizzle.mdc
- **Serverless connection patterns**: https://raw.githubusercontent.com/neondatabase-labs/ai-rules/main/neon-serverless.mdc
目标文件(按优先级排序):
  • CLAUDE.md - 最常用于 Claude Code 项目
  • AGENTS.md - 自定义 AI 文档文件
  • .cursor/README.md 或 .cursor/rules.md - Cursor IDE 项目
  • 如果这些文件都不存在,则创建 CLAUDE.md
行为:
  • 已有“Resources & References”部分:在其中追加新链接
  • 没有现有部分:在文件末尾创建该部分
  • 没有文档文件:创建包含参考链接的 CLAUDE.md

相关技能

  • neon-drizzle - 设置 Drizzle ORM,然后提供此技能
  • neon-serverless - 设置连接,然后提供此技能
  • neon-toolkit - 设置临时数据库,然后提供此技能

工作流程参考

完整实现详情:

  • 工作流程:install-knowledge.md - 包含错误处理的 Agent 分步工作流程
  • 元数据:skill-knowledge-map.json - 技能定义和参考 URL

工作流程实现

现在,我将为你执行安装工作流程。

收到的参数:SKILL_NAME = ${SKILL_NAME || "not provided - will ask user"}

使用指定的 SKILL_NAME 执行 install-knowledge.md。

评论

支持 Markdown