使用说明

项目简介

Stock MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,专注于提供实时股票报价服务。它通过简单的工具接口,使得 LLM 应用能够轻松获取股票市场的最新数据。

主要功能点

  • 实时股票报价查询: 通过 'get-quote' 工具,用户可以查询指定股票代码的实时报价信息,包括股票名称、当前价格、涨跌幅、开盘价、最高价、最低价、成交量、成交额以及更新时间等详细数据。
  • 标准 MCP 协议支持: 完全遵循 MCP 协议规范,可以与任何兼容 MCP 协议的 LLM 客户端(如 Claude Desktop、Cline 等)无缝集成。
  • 易于配置和部署: 提供简单的配置方式,可以通过 npm 包或直接运行 node 代码启动服务器,并提供了客户端配置示例。

安装步骤

  1. 克隆仓库:

    git clone https://github.com/YongYangLi/stock-mcp-server.git
    cd stock-mcp-server
  2. 安装依赖:

    npm install
  3. 构建项目:

    npm run build

服务器配置

要将 Stock MCP Server 集成到 MCP 客户端(例如 Claude Desktop 或 Cline),您需要配置客户端以连接到此服务器。以下是配置示例,您需要根据您的实际情况进行调整。

配置信息 (JSON 格式):

{
  "stock": {  // "stock" 为服务名称,客户端用此名称来标识和调用该 MCP 服务器
    "command": "npx", // 启动服务器的命令,这里使用 npx 运行 stock-mcp-server 包
    "args": [      // 传递给命令的参数
      "-y",        // npx 的参数,-y 表示自动安装依赖包
      "stock-mcp-server" // 要执行的 npm 包名,即 stock-mcp-server
    ]
  }
}

或者,如果您已经全局安装了 'stock-mcp-server' 或想直接运行构建后的 JavaScript 文件,可以使用以下配置:

{
  "stock": {  // "stock" 为服务名称
    "command": "node", // 启动服务器的命令,这里使用 node 运行 JavaScript 文件
    "args": [      // 传递给命令的参数
      "path/to/build/index.js" //  服务器入口文件路径,请替换为实际路径
    ]
  }
}

配置说明:

  • '"stock"': 这是您为该 MCP 服务器自定义的服务名称。在客户端配置中,您将使用此名称来引用和调用 Stock MCP Server 提供的工具。
  • '"command"': 指定用于启动 MCP 服务器的命令。常见的命令包括 'npx' (用于运行 npm 包) 和 'node' (用于直接运行 JavaScript 文件)。
  • '"args"': 一个字符串数组,包含传递给 'command' 的参数。
    • 当 'command' 为 '"npx"' 时,'args' 通常包含 '"-y"' (可选,自动安装包) 和 '"stock-mcp-server"' (要运行的 npm 包名称)。
    • 当 'command' 为 '"node"' 时,'args' 通常包含服务器入口文件 'index.js' 的路径。请务必根据您的实际文件路径进行修改。

重要提示:

  • 确保 MCP 客户端能够找到并执行您在 'command' 中指定的命令(例如 'npx' 或 'node')以及访问 'args' 中指定的文件路径。
  • 您需要将上述 JSON 配置添加到您的 MCP 客户端(如 Claude Desktop 或 Cline)的配置文件中,具体配置方法请参考您使用的 MCP 客户端的文档。

基本使用方法

  1. 启动 Stock MCP Server: 根据上述配置,MCP 客户端会在需要时自动启动 Stock MCP Server。

  2. 在 LLM 应用中使用 'get-quote' 工具: 在您的 LLM 应用中,当需要查询股票报价时,可以指示 LLM 调用 'stock:get-quote' 工具,并提供股票代码 (symbol) 作为参数。例如:

    请帮我查询一下 股票代码 sh600000 的实时报价。

    LLM 客户端会将该请求转发给 Stock MCP Server,服务器会调用 'get-quote' 工具查询股票数据,并将结果返回给 LLM 客户端,最终呈现给用户。

开发说明

如果您需要修改或扩展 Stock MCP Server,请参考仓库中的 'src/index.ts' 文件。您可以使用 'npm run dev' 命令进行开发,并使用 'npm run build' 命令构建生产版本。

信息

分类

网页与API