使用说明
项目简介
这是一个实验性的 Model Context Protocol (MCP) 服务器,旨在帮助开发者学习和集成 Nylas API。它提供了关于 Nylas API 的文档资源、代码示例、交互式工具和 Prompt 模板,所有资源都围绕 Nylas API 的邮件、日历和联系人功能展开。请注意,这是一个非官方的实验项目,仅供学习和实验目的使用。
主要功能点
- 文档资源 (Resources):
- 提供 Nylas API 各个模块(如邮件、日历、联系人等)的详细文档。
- 包含 Nylas API 端点、认证流程、最佳实践等信息。
- 提供代码示例和不同编程语言的 SDK 使用指南。
- 交互式工具 (Tools):
- 代码生成工具:
- 'generate-auth-code':根据选择的编程语言生成 Nylas API 认证代码片段。
- 'generate-endpoint-code':根据指定的 API 端点和编程语言生成代码示例。
- API 文档搜索工具:
- 'search-api-docs':允许用户搜索 Nylas API 文档,快速定位所需信息。
- 代码生成工具:
- Prompt 模板 (Prompts):
- 提供预定义的 Prompt 模板,用于常见的 Nylas API 集成场景。
- 包括快速入门、认证指南、邮件/日历/联系人功能集成、SDK 使用示例、调试指南等 Prompt。
安装步骤
- 克隆仓库
git clone https://github.com/nylas-samples/nylas-api-mcp.git cd nylas-api-mcp - 安装依赖
确保已安装 Node.js 18+ 和 npm。
npm install - 构建项目
npm run build
服务器配置
此 MCP 服务器可以通过 stdio 或 HTTP (SSE) 两种模式运行,以下是 MCP 客户端连接服务器时所需的配置信息。
1. Stdio 模式 (推荐本地客户端使用)
- 服务器名称 (Server Name): 'Nylas API MCP Server' (可自定义)
- 命令 (Command): 请填写 'node' (确保你的环境变量PATH中包含 Node.js 可执行文件路径)
- 参数 (Args): 请填写 '/path/to/nylas-api-mcp/dist/index.js' (请将 '/path/to/nylas-api-mcp' 替换为你克隆仓库的实际本地路径)
{ "serverName": "Nylas API MCP Server", "command": "node", "args": ["/path/to/nylas-api-mcp/dist/index.js"] }
参数注释:
- 'node': Node.js 运行时环境,用于执行 JavaScript 代码。
- '/path/to/nylas-api-mcp/dist/index.js': MCP 服务器的入口文件路径,指向编译后的 JavaScript 文件。请务必替换为实际路径。
2. HTTP SSE 模式 (适用于远程客户端或需要通过HTTP连接的场景)
- 服务器名称 (Server Name): 'Nylas API MCP Server (HTTP)' (可自定义)
- 命令 (Command): 请填写 'node' (确保你的环境变量PATH中包含 Node.js 可执行文件路径)
- 参数 (Args): 请填写 '/path/to/nylas-api-mcp/dist/index.js' 和 '--MCP_MODE=http' (请将 '/path/to/nylas-api-mcp' 替换为你克隆仓库的实际本地路径)
{ "serverName": "Nylas API MCP Server (HTTP)", "command": "node", "args": ["/path/to/nylas-api-mcp/dist/index.js", "--MCP_MODE=http"] }
参数注释:
- 'node': Node.js 运行时环境,用于执行 JavaScript 代码。
- '/path/to/nylas-api-mcp/dist/index.js': MCP 服务器的入口文件路径,指向编译后的 JavaScript 文件。请务必替换为实际路径。
- '--MCP_MODE=http': 通过环境变量 'MCP_MODE' 设置服务器运行在 HTTP SSE 模式。
端口配置: HTTP SSE 模式默认运行在 3000 端口。你可以通过设置 'PORT' 环境变量来修改端口,例如 'PORT=8080 npm start'。
基本使用方法
- 启动 MCP 服务器:
- Stdio 模式: 在仓库根目录下运行 'npm start'。
- HTTP SSE 模式: 在仓库根目录下运行 'MCP_MODE=http npm start' 或 'MCP_MODE=http PORT=8080 npm start' (指定端口)。
- 在 MCP 客户端中配置服务器:
- 以 Claude Desktop 或 Cursor 为例,按照 "使用说明" 中的服务器配置信息,将 Nylas API MCP Server 添加到 MCP 客户端的服务器列表中。
- 确保配置的命令和参数正确指向你本地的服务器启动脚本。
- 在 MCP 客户端中使用:
- 连接成功后,你可以在支持 MCP 协议的客户端中,通过自然语言与服务器交互,例如:
- 请求访问 Nylas API 文档资源,例如询问 "Show me Nylas Email API documentation"。
- 使用代码生成工具,例如请求 "Generate Python code to authenticate with Nylas API"。
- 使用 Prompt 模板,例如请求 "Explain Nylas authentication flow"。
- 连接成功后,你可以在支持 MCP 协议的客户端中,通过自然语言与服务器交互,例如:
通过以上步骤,你就可以在 MCP 客户端中利用 Nylas API MCP Server 提供的资源、工具和 Prompt,更方便地学习和集成 Nylas API。
信息
分类
开发者工具