使用说明

项目简介

'KOSPI/KOSDAQ Stock Data Server' 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为语言模型应用提供韩国KOSPI和KOSDAQ股票市场的全面数据访问能力。通过此服务器,您可以轻松获取股票代码、OHLCV(开盘价、最高价、最低价、收盘价、成交量)数据、市值、财务指标(PER/PBR/股息率)以及投资者类型的交易量等信息。

主要功能点

  • 股票代码查询: 支持查询KOSPI和KOSDAQ市场的股票代码和名称。
  • OHLCV数据: 获取指定股票在特定时间段内的 OHLCV 数据。
  • 市值数据: 查询指定股票在特定时间段内的市值数据。
  • 财务指标: 检索指定股票的财务指标,如 PER、PBR 和股息率。
  • 投资者交易量: 获取指定股票按投资者类型划分的交易量数据。

所有数据均来自韩国交易所 (KRX),并以结构化的JSON格式返回,方便语言模型理解和使用。

安装步骤

  1. 安装 uv: 本服务器依赖 'uv' 进行安装和运行,请确保您的系统已安装 uv。您可以访问 uv GitHub仓库 获取安装指南。
  2. 创建并激活虚拟环境: 打开终端,导航到您希望安装服务器的目录,并执行以下命令创建和激活虚拟环境:
    uv venv .venv
    source .venv/bin/activate  # On Unix/macOS
    # .venv\Scripts\activate   # On Windows
  3. 安装服务器软件包: 在激活的虚拟环境中,使用 uv 安装 'kospi-kosdaq-stock-server' 软件包:
    uv pip install kospi-kosdaq-stock-server

服务器配置

要将此 MCP 服务器与 MCP 客户端(例如 Claude 桌面应用)配合使用,您需要配置客户端的配置文件。以 Claude 桌面应用为例,您需要编辑 'claude_desktop_config.json' 文件,通常该文件位于:

  • macOS: '/Users/用户名/Library/Application Support/Claude/claude_desktop_config.json'
  • Windows: '%APPDATA%/Claude/claude_desktop_config.json'

在 'mcpServers' 对象中添加以下配置信息:

{
    "mcpServers": {
        "kospi-kosdaq": {  // 服务器名称,您可以自定义
            "command": "uvx", // 使用 uvx 命令启动,利用 uv 的环境隔离
            "args": ["kospi_kosdaq_stock_server"] // 服务器启动参数,此处为软件包名称
        }
    }
}

配置参数说明:

  • 'server name': 为您的服务器定义一个唯一的名称,例如 'kospi-kosdaq'。这个名称将在客户端配置中引用。
  • 'command': 指定用于启动服务器的命令。推荐使用 'uvx',它能确保在虚拟环境中运行服务器,隔离依赖关系。
  • 'args': 传递给启动命令的参数。对于此服务器,只需指定软件包名称 'kospi_kosdaq_stock_server',因为入口点已在软件包中定义。

保存配置文件后,重启您的 MCP 客户端(如 Claude 桌面应用)使配置生效。

基本使用方法

配置完成后,您可以在 MCP 客户端中使用以下方式与服务器交互:

  1. 加载股票代码: 首次使用或需要更新股票代码列表时,请先调用 'load_all_tickers' 工具加载所有 KOSPI 和 KOSDAQ 股票代码到内存中。例如,在 Claude 中您可以这样指示:

    Human: 请加载所有股票代码。

    客户端会调用 'load_all_tickers' 工具,加载完成后会返回成功消息和股票数量。

  2. 查询股票数据: 使用各种 'get_stock_xxx' 工具查询具体的股票数据。例如,要查询三星电子(股票代码:005930)过去一个月的 OHLCV 数据,您可以指示:

    Human: 请展示三星电子过去一个月的股票数据。

    客户端会识别您的意图,并调用 'get_stock_ohlcv' 工具,提供日期范围和股票代码等参数。服务器会返回 JSON 格式的 OHLCV 数据。

    您还可以使用 'stock://tickers' 资源查询已加载的股票代码映射,使用 'stock://format-guide' 资源获取输入格式指南,以及 'stock://popular-tickers' 资源获取常用股票代码列表。

请参考仓库 'README.md' 文件中 "Usage Example" 部分获取更详细的使用示例。

信息

分类

商业系统