Akshare MCP Server

🚀 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 許可證。