@niklaserik/effect-mcp

@niklaserik/effect-mcp

专为从 Effect 生态系统获取最新文档而打造的模型上下文协议（MCP）服务。

用途

此 MCP 服务为 AI 助手和工具提供对 Effect 文档的实时访问。它支持 VS Code 扩展和其他 MCP 客户端获取准确、最新的 Effect 包文档，帮助开发者解答以下方面的问题：

• 核心 effect 包
• 生态系统包（@effect/platform、@effect/ai 等）
• 稳定版和非稳定版 Effect 包

该服务会智能检测代码中导入的 Effect 包，并获取最相关的文档以回答你的问题。

功能

• 实时访问 Effect 生态系统文档
• 支持稳定版和实验性包
• 根据导入内容检测上下文相关的包
• 与 VS Code 和其他兼容 MCP 的客户端无缝集成
• 帮助 Effect 开发者解答 API 使用问题

此服务公开的内容

• 资源（首选）
  • 动态模板：effect-docs://{libId}
  • 支持对 {libId} 进行补全，并支持资源列表
  • 用于发现的静态别名：effect-docs://effect、effect-docs://@effect-platform 等
  • 当前支持的库：
    • effect
    • @effect/platform
    • @effect/sql
    • @effect/vitest
    • @effect/ai
    • @effect/cli
    • @effect/cluster
    • @effect/rpc
    • @effect/typeclass
• 工具（用于兼容性）
  • effect-documentation：获取所选库的文档，并返回拼接后的 Markdown
  • effect-doc-links：返回上述资源的纯 URI，供客户端访问

缓存与重试

• 使用内存中的 TTL 缓存（约 10 分钟），避免重新获取未更改的文档。
• 在获取发生暂时性错误时，进行轻量重试，并采用较短的退避间隔。

安装

pnpm add @niklaserik/effect-mcp

使用

要在 VS Code 或其他 MCP 客户端中使用，请参阅客户端的文档，了解如何添加自定义 MCP 服务。

本地快速测试：

pnpm install
pnpm build
node dist/index.js # stdio transport

然后通过 stdio 连接 MCP 客户端（例如 MCP Inspector），并尝试：

• 列出资源并读取 effect-docs://effect
• 使用 { "libraries": ["effect", "@effect/platform"] } 调用工具 effect-doc-links

初始化说明

• 此服务会通过 MCP initialize 发布简短的使用说明，供会显示这些说明的客户端使用。

开发

# Install dependencies
pnpm install

# Build the project
pnpm build

# Run in development mode with auto-reload
pnpm dev

注意：

• 使用 @modelcontextprotocol/sdk@^1.17.4 构建，并采用现代的 registerResource/registerTool API。
• 传输方式：默认使用 stdio；需要时可改用 Streamable HTTP。

许可证

MIT