使用说明

项目简介

Jotai MCP 服务器是一个实现了 Model Context Protocol (MCP) 的服务器,旨在为 LLM 应用提供 Jotai 状态管理库的文档资源访问能力。通过该服务器,客户端可以标准化地获取 Jotai 的 README 文档以及面向赞助者的使用技巧等资源。

主要功能点

  • 资源访问: 提供对 Jotai 项目 README 文件的访问,允许客户端通过 MCP 协议获取最新的项目介绍和文档。
  • 赞助者内容: 为 dai-shi 的 GitHub 赞助者提供额外的 "tips" 资源,包含 Jotai 使用技巧(需要配置 GitHub Personal Access Token)。
  • 标准 MCP 协议: 基于 Model Context Protocol 标准构建,易于集成到支持 MCP 协议的 LLM 应用中。
  • Stdio 传输: 使用 Stdio 作为默认的传输协议,简化部署和集成。

安装步骤

  1. 安装 Deno: 确保您的环境中已安装 Deno 运行时。您可以访问 https://deno.land/ 了解安装方法。

服务器配置

MCP 客户端需要配置以下信息以连接到 Jotai MCP 服务器。请将以下 JSON 配置添加到您的 MCP 客户端配置中:

{
  "mcpServers": {
    "jotai-mcp-server": {
      "command": "deno",
      "args": ["run", "--allow-env", "--allow-net", "npm:jotai-mcp-server"],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_GITHUB_TOKEN"  // 可选:如果您需要访问 "tips" 资源,请替换为您的 GitHub Personal Access Token
      }
    }
  }
}

配置参数说明:

  • 'server name': 'jotai-mcp-server' (服务器名称,用于在客户端配置中标识)
  • 'command': 'deno' (启动服务器的命令,这里使用 Deno 运行时)
  • 'args': '["run", "--allow-env", "--allow-net", "npm:jotai-mcp-server"]' (命令参数,'run' 表示运行脚本,'--allow-env' 允许访问环境变量,'--allow-net' 允许网络请求,'npm:jotai-mcp-server' 指定运行 npm 包 'jotai-mcp-server' 作为服务器)
  • 'env': '{ "GITHUB_PERSONAL_ACCESS_TOKEN": "YOUR_GITHUB_TOKEN" }' (环境变量配置,'GITHUB_PERSONAL_ACCESS_TOKEN' 用于 GitHub API 访问,可选,仅当您需要访问 "tips" 资源时才需要配置。如果您是 dai-shi 的 GitHub 赞助者,请在 GitHub settings/Developer settings/Personal access tokens classic 中创建 personal access token 并替换 'YOUR_GITHUB_TOKEN'。不需要任何 scopes,仅用于验证赞助者身份。)

基本使用方法

配置完成后,您的 MCP 客户端应该能够连接到 Jotai MCP 服务器。客户端可以使用 MCP 协议请求访问以下资源:

  • 'docs://readme': 获取 Jotai 项目的 README 文件内容。
  • 'docs://tips': 获取 Jotai 使用技巧(仅赞助者可用)。

具体的资源访问方式请参考您的 MCP 客户端软件的使用文档。

信息

分类

开发者工具