关键词

台湾股票TWSE股票数据金融数据实时市场数据

使用说明

项目简介

本项目 'mcp-server-twse' 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为大型语言模型 (LLM) 应用提供台湾证券交易所 (TWSE) 的实时股票信息查询功能。它通过 MCP 协议的标准接口与客户端通信，允许 LLM 客户端调用预定义的工具来获取最新的股票数据。

主要功能点

  • 提供股票信息查询工具: 通过 'query_stock_info_from_twse' 工具，LLM 客户端可以查询指定台湾股票代码的实时交易信息。
  • 实时数据: 从 TWSE 获取最新的股票交易数据，包括价格、涨跌幅、成交量等。
  • MCP 标准协议: 遵循 MCP 协议，易于与支持 MCP 协议的 LLM 客户端集成。
  • 使用 FastMCP 框架: 基于 'fastmcp' 库构建，保证了服务器的稳定性和性能。

安装步骤

本仓库提供了两种安装服务器的方法：

方法一：使用 'uvx' (推荐)

'uvx' 可以直接从 GitHub 安装并运行服务器。这是最简便的安装方式。

  1. 确保您的 MCP 客户端支持配置 MCP 服务器，并允许您指定服务器的启动命令和参数。
  2. 在您的 MCP 客户端配置中，添加以下 JSON 配置信息。这将指示客户端使用 'uvx' 命令从 GitHub 下载并运行 'mcp-server-twse' 服务器。
{
  "mcpServers": {
    "mcp-server-twse": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/narumiruna/mcp-server-twse",
        "mcp-server-twse"
      ]
    }
  }
}

方法二：本地运行 (开发模式)

如果您希望本地开发或修改服务器代码，可以使用 'uv' 命令在本地运行。

  1. 克隆仓库: 首先将 'mcp-server-twse' 仓库克隆到本地。 
    git clone https://github.com/narumiruna/mcp-server-twse
cd mcp-server-twse
  2. 确保您的 MCP 客户端支持配置 MCP 服务器，并允许您指定服务器的启动命令和参数。
  3. 在您的 MCP 客户端配置中，添加以下 JSON 配置信息。请将 '/home/<user>/workspace/mcp-server-twse' 替换为您本地仓库的实际路径。这将指示客户端使用 'uv' 命令在指定的本地目录中运行 'mcp-server-twse' 服务器。
{
  "mcpServers": {
    "mcp-server-twse": {
      "command": "uv",
      "args": [
        "run",
        "--directory",
        "/home/<user>/workspace/mcp-server-twse",
        "mcp-server-twse"
      ]
    }
  }
}

服务器配置

MCP 客户端需要配置 MCP 服务器的启动信息，以便连接和使用服务器提供的功能。以下是配置的关键信息（JSON 格式）：

{
  "mcpServers": {
    "mcp-server-twse": {  // 服务器名称，客户端用此名称引用
      "command": "uvx",    // 启动服务器的命令，或 "uv" (本地运行)
      "args": [            // 命令参数列表
        "--from",          // (仅 uvx) 从哪里安装
        "git+https://github.com/narumiruna/mcp-server-twse", // (仅 uvx) GitHub 仓库地址
        "mcp-server-twse" // (仅 uvx) 要运行的服务器名称，与仓库名一致
        // 或
        // "run",           // (仅 uv) uv 命令为 run
        // "--directory",   // (仅 uv) 指定服务器代码所在目录
        // "/path/to/mcp-server-twse", // (仅 uv) 本地仓库路径，请替换为实际路径
        // "mcp-server-twse" // (仅 uv) 要运行的服务器名称
      ]
    }
  }
}

请根据您的实际使用场景（在线安装或本地开发）选择合适的配置，并将其添加到您的 MCP 客户端配置中。

基本使用方法

  1. 启动 MCP 服务器: 根据上述安装步骤配置好 MCP 客户端后，启动 MCP 服务器。服务器将在后台运行并等待客户端连接。
  2. 客户端调用工具: 在 LLM 客户端中，您可以使用 'query_stock_info_from_twse' 工具来查询股票信息。例如，要查询股票代码为 "2330" 的股票信息，您需要向 MCP 服务器发送一个工具调用请求，指定工具名称为 'query_stock_info_from_twse'，并提供参数 '{"symbol": "2330"}'。
  3. 获取股票信息: 服务器将调用 TWSE API 获取实时股票数据，并将结果格式化后返回给客户端。返回的数据包含了股票的名称、代码、最新价格、涨跌幅、成交量等信息。

示例 (客户端请求 - 假设使用 JSON-RPC over WebSocket):

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "tool_name": "query_stock_info_from_twse",
    "tool_args": {
      "symbol": "2330"
    }
  },
  "id": 1
}

示例 (服务器响应 - 成功):

服务器会返回包含格式化股票信息的 JSON-RPC 响应。具体格式请参考 'src/mcp_server_twse/twse.py' 中的 'StockInfoResponse.pretty_repr()' 方法。

{
  "jsonrpc": "2.0",
  "result": "📊 *台积电 \\(2330\\)*\nOpen: '580.00'\nHigh: '585.00'\nLow: '575.00'\nLast: '582.00'\nChange: 🔺 '+0.34%'\nVolume: '12,345'",
  "id": 1
}

请注意，以上示例仅为说明用途，实际的请求和响应格式可能会因 MCP 客户端的具体实现而略有不同。请参考您的 MCP 客户端文档以获取更详细的使用信息。

信息

分类

网页与API

访问项目