使用说明

项目简介

TWSE MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在向 LLM 客户端提供台湾证券交易所 (TWSE) 的股票市场数据。该服务器通过实现 MCP 协议,允许 LLM 应用以标准化的方式访问实时的股票信息,从而增强 LLM 在金融信息处理和分析方面的能力。

主要功能点

  • 提供股票信息查询工具: 服务器注册了一个名为 'get_stock_info' 的工具,允许客户端查询指定股票代码的实时信息。
  • 实时数据获取: 通过调用台湾证券交易所的 API,服务器能够获取最新的股票交易数据。
  • JSON-RPC 协议支持: 遵循 MCP 协议规范,使用 JSON-RPC 与客户端进行通信,实现请求和响应的标准化处理。
  • 易于集成: 作为 MCP 服务器,可以方便地与任何支持 MCP 协议的 LLM 客户端集成,为 LLM 应用扩展数据访问能力。

安装步骤

由于该仓库主要提供服务器端代码,安装步骤侧重于如何运行该服务器。

  1. 环境准备: 确保你的环境中已安装 Python 3.12 或更高版本。建议使用虚拟环境来隔离项目依赖。
  2. 安装依赖: 虽然仓库中没有明确的安装依赖步骤,但根据 'scripts/fetch_twse_stocks.py' 文件中的注释,可以推断出可能需要的 Python 库包括 'beautifulsoup4', 'httpx', 'pandas', 'rich', 'typer'。 建议安装这些库以确保完整功能 (虽然服务器核心功能可能不依赖所有这些库)。可以使用 'pip' 或 'uv' 等包管理工具进行安装。 例如使用 'uv pip install beautifulsoup4 httpx pandas rich typer'。
  3. 获取代码: 从 GitHub 克隆或下载该仓库的代码。
  4. 运行服务器: 进入代码仓库的根目录,使用 'uv' 或 'uvx' 运行服务器。根据 'README.md' 提供的配置信息,服务器的启动命令如下。

服务器配置

MCP 客户端需要配置以下 JSON 格式的信息才能连接到 TWSE MCP 服务器。以下是根据仓库 'README.md' 生成的配置信息,请注意,MCP客户端无需安装 uv 或 uvx,只需配置如下服务器信息即可

使用 'uvx' (推荐,从 Git 仓库直接运行):

{
  "mcpServers": {
    "twsemcp": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/narumiruna/twse-mcp",
        "twsemcp"
      ]
    }
  }
}
  • 'command': 指定启动服务器的命令为 'uvx',这是一个可以从 Git 仓库直接运行 Python 应用的工具。
  • 'args': 命令参数列表。
    • '--from git+https://github.com/narumiruna/twse-mcp': 指定从 GitHub 仓库 'https://github.com/narumiruna/twse-mcp' 获取代码。
    • 'twsemcp': 指定运行 'twsemcp' 入口点,这通常对应于项目中的某个可执行脚本或模块 (根据代码推测,可能是 'src/twsemcp/server.py' 中的 'main' 函数)。

使用 'uv' (本地运行,需要先将代码下载到本地): 请将 '/home/<user>/workspace/twse-mcp' 替换为实际的代码存放路径。

{
  "mcpServers": {
    "twsemcp": {
      "command": "uv",
      "args": [
        "run",
        "--directory",
        "/home/<user>/workspace/twse-mcp",
        "twsemcp"
      ]
    }
  }
}
  • 'command': 指定启动服务器的命令为 'uv',这是一个 Python 包和虚拟环境管理工具。
  • 'args': 命令参数列表。
    • 'run': 'uv' 的子命令,用于运行 Python 代码。
    • '--directory /home/<user>/workspace/twse-mcp': 指定代码所在的本地目录。 请务必替换为实际路径
    • 'twsemcp': 指定运行 'twsemcp' 入口点。

选择配置: 推荐使用 'uvx' 配置,因为它更方便,可以直接从 Git 仓库运行,无需手动下载代码到本地。

基本使用方法

  1. 启动 MCP 客户端: 确保你使用的 LLM 客户端支持 MCP 协议,并按照客户端的文档配置上述服务器连接信息。
  2. 发现工具: 客户端启动后,通常会先与 MCP 服务器建立连接并发现服务器提供的工具。客户端应该能够列出名为 'get_stock_info' 的工具。
  3. 调用工具: 使用 'get_stock_info' 工具查询股票信息。你需要提供股票代码 (symbols) 作为参数。 例如,查询 "2330" 台积电的股票信息,可以向 'get_stock_info' 工具发送如下参数:
    {
      "symbols": ["2330"]
    }
  4. 获取结果: 服务器会返回包含股票信息的 JSON 响应。客户端解析 JSON 响应,即可获取股票的实时数据。

注意: 'full_info' 参数在 'get_stock_info' 工具中可用,用于控制返回信息的详细程度。 默认为 'true' 返回完整信息。

信息

分类

网页与API