关键词

Effect.js文档API实时数据工具

Effect 文档 MCP 服务器使用说明

项目简介

Effect 文档 MCP 服务器是一个基于 Model Context Protocol (MCP) 标准构建的后端服务，旨在为大型语言模型 (LLM) 应用提供 Effect.js 生态系统的实时文档访问能力。通过此服务器，LLM 应用可以获取最新的 Effect.js 库和工具的文档信息，从而更好地理解和使用 Effect.js 进行开发。

主要功能点

  • 实时文档访问: 为 LLM 应用提供 Effect.js 生态系统的最新文档内容。
  • 支持 Effect 生态: 覆盖 'effect' 核心库以及 '@effect/platform', '@effect/ai' 等生态库的文档。
  • 工具集成: 通过 MCP 协议提供 'effect-documentation' 工具，方便 LLM 客户端调用以获取文档。
  • 易于集成: 遵循 MCP 标准，可以与任何兼容 MCP 协议的 LLM 客户端轻松集成，例如 VS Code 插件或其他 MCP 客户端。

安装步骤

  1. 安装 npm 包: 在您的项目中使用 pnpm 安装 '@niklaserik/effect-mcp' 包： 
    pnpm add @niklaserik/effect-mcp

服务器配置

为了让 MCP 客户端连接到 Effect 文档 MCP 服务器，您需要在客户端中配置服务器信息。以下是一个典型的 JSON 格式配置示例，您需要根据您的实际情况进行调整。

{
  "serverName": "Effect Documentation",
  "command": "node",
  "args": ["./node_modules/@niklaserik/effect-mcp/bin.js"]
}

配置参数说明:

  • 'serverName': 服务器的名称，可以自定义，例如 "Effect Documentation"。
  • 'command': 启动服务器的命令，这里使用 'node'。 确保您的环境中 'node' 命令可用。
  • 'args': 传递给 'command' 的参数，用于指定服务器启动脚本的路径。 './node_modules/@niklaserik/effect-mcp/bin.js' 指向已安装的 'effect-mcp' 包的启动入口 'bin.js' 文件。 请确保此路径相对于 MCP 客户端的运行环境是正确的。

注意: 上述 'args' 中的路径是基于项目根目录下 'node_modules' 目录的相对路径。如果您的 MCP 客户端运行环境与服务器安装位置不同，您可能需要调整 'args' 中的路径以指向正确的 'bin.js' 文件位置。

基本使用方法

  1. 启动服务器: 配置完成后，在 MCP 客户端中启动 "Effect Documentation" 服务器。服务器将在后台运行，并通过标准输入/输出 (stdio) 与客户端通信。

  2. 调用 'effect-documentation' 工具: 在 LLM 应用中，您可以使用 MCP 客户端提供的接口调用 'effect-documentation' 工具。该工具接受一个 'libraries' 参数，用于指定需要查询文档的 Effect.js 库列表。例如：

    {
  "tool_calls": [
    {
      "id": "tool_call_id_1",
      "type": "function",
      "function": {
        "name": "effect-documentation",
        "parameters": {
          "libraries": ["effect", "@effect/platform"]
        }
      }
    }
  ]
}

    服务器将根据 'libraries' 参数获取相应的 Effect.js 文档，并以 MCP 响应格式返回给客户端。客户端可以进一步处理这些文档信息，以满足 LLM 应用的需求。

请参考您的 MCP 客户端的文档，了解如何在客户端中添加和配置 MCP 服务器，以及如何调用 MCP 工具。

信息

分类

开发者工具

访问项目