🚀 AKShare MCP 服务器

AKShare MCP 服务器是一个借助 AKShare 库，提供金融市场数据分析功能的 Model Context Protocol (MCP) 服务器，能助力用户高效获取和分析金融数据。

🚀 快速开始

若你想快速体验 AKShare MCP 服务器，可参考以下步骤：

1. 完成服务器的安装（具体安装方式见“📦 安装指南”）。
2. 启动服务器（具体启动方法见“💻 使用示例”）。
3. 若有需要，将其集成到 Claude Desktop 中（具体集成步骤见“💻 使用示例”）。

✨ 主要特性

• 广泛的数据访问：可通过 AKShare 访问中国和全球金融市场的数据。
• 便捷的集成方式：能够集成到 Claude Desktop 中，通过 MCP 协议使用。
• 丰富的功能支持：支持各种金融数据查询和分析。

📦 安装指南

使用 uv（推荐）

# 克隆仓库
git clone https://github.com/yourusername/akshare_mcp_server.git
cd akshare_mcp_server

# 创建并激活虚拟环境
python -m venv venv
source venv/bin/activate  # Windows 系统请使用：venv\Scripts\activate

# 使用 uv 安装依赖
uv pip install -e .

使用 pip

# 克隆仓库
git clone https://github.com/yourusername/akshare_mcp_server.git
cd akshare_mcp_server

# 创建并激活虚拟环境
python -m venv venv
source venv/bin/activate  # Windows 系统请使用：venv\Scripts\activate

# 安装依赖
pip install -e .

💻 使用示例

基础用法

运行服务器

# 激活虚拟环境
source venv/bin/activate  # Windows 系统请使用：venv\Scripts\activate

# 启动服务器
python run_server.py

集成到 Claude Desktop

1. 将以下配置添加到你的 Claude Desktop 配置文件中：

"mcpServers": {
    "akshare-mcp": {
        "command": "uv",
        "args": [
            "--directory",
            "/path/to/akshare_mcp_server",
            "run",
            "akshare-mcp"
        ],
        "env": {
            "AKSHARE_API_KEY": "<your_api_key_if_needed>"
        }
    }
}

2. 重启 Claude Desktop。
3. 在可用工具中选择 AKShare MCP 服务器。

高级用法

可用工具

AKShare MCP 服务器提供了以下工具：

• 股票数据查询
• 基金数据查询
• 债券数据查询
• 期货数据查询
• 外汇数据查询
• 宏观经济数据查询
• 以及其他更多功能...

添加新工具

要在 MCP 服务器中添加新的工具，请按照以下步骤操作：

1. 在 src/mcp_server_akshare/api.py 中添加一个新的 API 函数：

async def fetch_new_data_function(param1: str, param2: str = "default") -> List[Dict[str, Any]]:
    """
    获取新数据类型。
    
    参数：
        param1: 描述参数 1
        param2: 描述参数 2（可选）
    """
    try:
        df = ak.akshare_function_name(param1=param1, param2=param2)
        return dataframe_to_dict(df)  # 假设 df 是 DataFrame 对象
    except Exception as e:
        raise ValueError(f"获取数据时发生错误：{str(e)}")

2. 在 src/mcp_server_akshare/api.py 中注册新函数：

from typing import List, Dict, Any

def register_new_function():
    from .server import server
    from ..commands.base import command
    
    @command()
    async def new_command(self):
        # 在这里实现你的命令逻辑
        pass

    server.commands.append(new_command)

3. 在 src/mcp_server_akshare/__init__.py 中导入新函数：

from .api import fetch_new_data_function, register_new_function

# 注册新功能
register_new_function()

4. 重启服务器以应用更改

🔧 技术细节

代码结构

• src/mcp_server_akshare/：包含 MCP 服务器的核心实现。
• src/mcp_server_akshare/api.py：定义了与 AKShare 的接口和数据处理逻辑。
• src/mcp_server_akshare/server.py：实现了 MCP 服务器的主逻辑。
• src/mcp_server_akshare/commands/：包含各种命令的实现。

贡献指南

1. 提交代码前，请确保通过了所有测试。
2. 遵循 PEP8 编码规范。
3. 提供详细的文档说明。

📦 Docker 运行指南

# 构建镜像
docker build -t akshare-mcp-server .

# 启动容器
docker run -p 8000:8000 --name akshare-mcp-server akshare-mcp-server

📄 许可证

本项目采用 MIT 许可证。