项目简介

本项目是一个实现了Model Context Protocol (MCP) 的服务器,旨在为LLM客户端提供股票市场数据。它集成了聚合数据(Juhe Finance)API,可以获取中国(沪深)和美国股市的实时行情数据,包括股票和指数信息。通过本服务器,LLM应用可以方便地查询股票价格、涨跌幅等信息,从而增强在金融领域的应用能力。

主要功能点

  • 提供股票数据资源 (Resources)
    • 支持通过资源URI访问沪深股票和指数的实时数据。
    • 支持通过资源URI访问美国股票市场数据。
  • 提供股票数据查询工具 (Tools)
    • 提供工具调用,允许LLM客户端通过指定股票代码或指数类型,获取实时的股票数据。
    • 支持分页查询美国股票数据。
  • 数据来源: 聚合数据 (Juhe Finance) API。
  • 传输协议: Stdio (标准输入输出)。

安装步骤

  1. 克隆仓库
    git clone https://github.com/Penn-Lam/RuleForge
  2. 进入服务器目录
    cd RuleForge/mcp_server/juheFinance-mcp
  3. 安装依赖 确保已安装Node.js和npm,然后运行:
    npm install
  4. 配置API密钥 在 'mcp_server/juheFinance-mcp' 目录下创建 '.env' 文件,并填入从聚合数据申请的API密钥:
    JUHE_API_KEY=YOUR_API_KEY  # 替换为你的聚合数据API密钥
    注意: 请访问 聚合数据官网 申请金融数据API密钥。

服务器配置

MCP客户端需要配置以下JSON信息以连接到本MCP服务器:

{
  "serverName": "juhe-finance-stock-data",
  "command": "node",
  "args": ["dist/index.js"]
}

配置参数说明:

  • 'serverName': MCP服务器的名称,用于标识和区分不同的服务器。
  • 'command': 启动MCP服务器的命令。这里使用 'node' 命令来执行JavaScript代码,确保你的运行环境中已安装Node.js。
  • 'args': 传递给 'command' 的参数,指向编译后的服务器入口文件 'dist/index.js'。

基本使用方法

  1. 启动MCP服务器 在 'RuleForge/mcp_server/juheFinance-mcp' 目录下,打开终端并执行以下命令启动服务器:

    npm run start

    或者直接使用配置中的命令:

    node dist/index.js

    服务器成功启动后,会在控制台输出 "Juhe Finance Stock MCP Server running on stdio"。

  2. 在MCP客户端中使用 在支持MCP协议的客户端(如Cursor或Windsurf)中,按照客户端的指引配置并连接到本MCP服务器。

    • 资源 (Resources): 客户端可以使用以下URI格式访问股票数据资源:

      • 获取沪深股票数据: 'hs-stock://{股票代码}',例如 'hs-stock://sh600519' (贵州茅台), 'hs-stock://sz000001' (平安银行)。
      • 获取沪深指数数据: 'hs-stock://{指数类型}','0' 代表上证指数,'1' 代表深证成指,例如 'hs-stock://0' (上证指数), 'hs-stock://1' (深证成指)。
      • 获取美国股票数据: 'us-stock://{页码}/{每页条数类型}',页码为正整数,每页条数类型 '1' 代表20条/页, '2' 代表40条/页, '3' 代表60条/页,例如 'us-stock://1/1' (美国股票市场第一页,每页20条)。
    • 工具 (Tools): 客户端可以调用以下工具来查询股票数据:

      • 'get-hs-stock-data': 获取沪深股票或指数数据。参数可以是 '{ "gid": "股票代码" }' 或 '{ "type": "指数类型" }' ('"0"' 或 '"1"' )。
      • 'get-us-stock-data': 获取美国股票数据。参数可以是 '{ "page": "页码", "type": "每页条数类型" }'。

    LLM可以通过以上资源和工具获取股票数据,用于分析或生成相关内容。请参考MCP客户端的文档,了解如何在客户端中使用MCP服务器提供的资源和工具。

信息

分类

网页与API