使用说明

项目简介

本项目 'mcp-servers' 仓库包含两个基于 Model Context Protocol (MCP) 的微服务,分别提供以下功能:

  • Linear Service: 集成 Linear API,提供任务和项目管理能力。
  • Weather Service: 集成美国国家气象局 (NWS) API,提供天气数据查询能力。

这两个微服务均实现了 MCP 服务器,可以与支持 MCP 协议的 LLM 客户端进行交互,为 LLM 应用提供结构化的上下文信息和功能调用。

主要功能点

Linear Service:

  • 资源 (Resource): 公开 Linear 中的团队 (teams) 信息,客户端可以读取 'linear://teams' 资源获取团队列表。
  • 工具 (Tool): 提供 'create_task' 工具,允许客户端在指定的 Linear 团队中创建新任务。
  • Prompt 模板 (Prompt): 提供 'create-task-template' Prompt 模板,用于生成符合团队规范的任务创建提示。

Weather Service:

  • 工具 (Tool):
    • 'get-alerts': 查询指定州的天气警报信息。
    • 'get-forecast': 查询指定经纬度位置的天气预报信息。

安装步骤

  1. 克隆仓库

    git clone https://github.com/rajkstats/mcp-servers.git
    cd mcp-servers
  2. 进入服务目录: 选择您要运行的服务目录,例如 'linear' 或 'weather'。

    cd linear  # 或 cd weather
  3. 安装依赖

    npm install

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令和参数才能连接和使用服务。以下是 Linear Service 和 Weather Service 的服务器配置信息示例 (JSON 格式):

Linear Service 配置:

{
  "server_name": "Linear",
  "command": "node",
  "args": ["./linear/src/index.js", "<YOUR_LINEAR_API_KEY>"]
}

参数说明:

  • 'server_name': 服务器名称,例如 "Linear"。
  • 'command': 启动服务器的命令,这里使用 'node' 运行 JavaScript 代码。
  • 'args': 启动命令的参数列表:
    • '"./linear/src/index.js"': Linear Service 的入口文件路径。
    • '"<YOUR_LINEAR_API_KEY>"': 请替换为您的 Linear API 密钥。 您需要在 Linear 开发者平台 获取 API 密钥。

Weather Service 配置:

{
  "server_name": "Weather",
  "command": "node",
  "args": ["./weather/src/index.js"]
}

参数说明:

  • 'server_name': 服务器名称,例如 "Weather"。
  • 'command': 启动服务器的命令,这里使用 'node' 运行 JavaScript 代码。
  • 'args': 启动命令的参数列表:
    • '"./weather/src/index.js"': Weather Service 的入口文件路径。
    • Weather Service 不需要 API 密钥。

基本使用方法

  1. 启动服务器: 在服务目录(例如 'linear' 或 'weather')中,运行以下命令启动 MCP 服务器:

    npm start

    服务器成功启动后,会在控制台输出 "Linear MCP Server is running" 或 "Weather MCP Server running on stdio" 等信息。

  2. 配置 MCP 客户端: 在您的 MCP 客户端中,根据上述 “服务器配置” 部分提供的 JSON 配置信息,添加 Linear 或 Weather 服务的配置。确保将 '<YOUR_LINEAR_API_KEY>' 替换为您的实际 Linear API 密钥 (仅 Linear Service 需要)。

  3. 使用 MCP 客户端与服务器交互: 启动 MCP 客户端后,客户端将自动连接到配置的 MCP 服务器。您可以使用客户端提供的界面或 API,浏览和调用服务器提供的资源、工具和 Prompt 模板,例如:

    • 读取 'linear://teams' 资源以获取 Linear 团队列表。
    • 调用 'create_task' 工具在 Linear 中创建任务。
    • 调用 'get-alerts' 工具查询指定州的天气警报。
    • 调用 'get-forecast' 工具查询指定位置的天气预报。
    • 使用 'create-task-template' Prompt 模板生成任务创建提示。

请参考您的 MCP 客户端的使用文档,了解如何发现、调用和使用 MCP 服务器提供的功能。

信息

分类

网页与API