使用说明

项目简介

polygon-MCP 服务器是一个实现了 Model Context Protocol (MCP) 的后端服务,旨在为大型语言模型 (LLM) 客户端提供访问实时股票市场数据的能力。它通过资源和工具两种方式,允许 LLM 获取股票价格和相关信息,数据来源于 Polygon.io API。

主要功能点

  • 资源 (Resources):
    • 提供当前股票价格资源:通过 'stock://AAPL/current' URI 可以获取 AAPL 股票的实时价格数据,包括价格、开盘价、最高价、最低价、成交量等信息,数据格式为 JSON。
  • 工具 (Tools):
    • 'get_stock_price' 工具:允许用户查询指定股票代码和日期的股票价格信息。用户可以提供股票代码(symbol)和可选的日期(date,YYYY-MM-DD 格式)作为参数,获取对应股票在特定日期或最新交易日的价格数据。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/Emir-Danisik/polygon-MCP.git
    cd polygon-MCP
  2. 安装依赖: 确保你已安装 Node.js 和 npm,然后运行:
    npm install
  3. 配置 Polygon.io API 密钥: 在 Polygon.io 官网申请 API 密钥,然后在项目根目录下创建 '.env' 文件,并添加以下内容,将 'YOUR_POLYGON_API_KEY' 替换为你申请的密钥:
    POLYGON_API_KEY=YOUR_POLYGON_API_KEY
  4. 构建服务器: 运行以下命令构建服务器代码:
    npm run build

服务器配置

要将 polygon-MCP 服务器添加到 MCP 客户端(例如 Claude Desktop),你需要配置服务器信息。以下是 'claude_desktop_config.json' 文件的配置示例。请根据你的实际项目路径进行调整。

配置示例 (JSON):

{
  "mcpServers": {
    "polygon-server": {
      "command": "/path/to/polygon-MCP/build/index.js"
    }
  }
}

配置参数说明:

  • 'server name': 'polygon-server' (服务器名称,可自定义)
  • 'command': '/path/to/polygon-MCP/build/index.js' (服务器启动命令,请将 '/path/to/polygon-MCP' 替换为你本地 polygon-MCP 仓库的绝对路径)

例如,如果你的 'polygon-MCP' 仓库在用户 home 目录下,MacOS 系统上的 'command' 可能配置为:

{
  "mcpServers": {
    "polygon-server": {
      "command": "/Users/你的用户名/polygon-MCP/build/index.js"
    }
  }
}

Windows 系统上的 'command' 可能配置为:

{
  "mcpServers": {
    "polygon-server": {
      "command": "C:\\Users\\你的用户名\\polygon-MCP\\build\\index.js"
    }
  }
}

基本使用方法

  1. 启动服务器: 在 'polygon-MCP' 仓库目录下,运行以下命令启动 MCP 服务器:

    npm run start

    服务器将在 stdio 上运行,并输出 "Polygon Stock MCP server running on stdio" 表示启动成功。

  2. 在 MCP 客户端中使用:

    • 确保你已按照 "服务器配置" 步骤将 'polygon-server' 添加到 MCP 客户端的配置文件中。
    • 在 MCP 客户端中,你可以通过以下方式访问 polygon-MCP 服务器的功能:
      • 访问资源: 在客户端中请求 'stock://AAPL/current' 资源 URI,即可获取 AAPL 股票的实时数据。
      • 调用工具: 调用 'get_stock_price' 工具,并提供 'symbol' (股票代码,如 AAPL) 和 'date' (日期,YYYY-MM-DD 格式,可选) 参数,即可查询股票价格信息。

    具体操作方式请参考你使用的 MCP 客户端的文档。

调试: 如果需要调试 MCP 服务器,可以使用仓库 'README.md' 中推荐的 MCP Inspector 工具。运行 'npm run inspector' 即可启动 Inspector,它会提供一个浏览器 URL 用于调试。

信息

分类

网页与API