Akshare MCP Server

🚀 AKShare MCP Server

An MCP (Model Context Protocol) server that provides financial market data analysis capabilities, utilizing the AKShare library.

🚀 Quick Start

The AKShare MCP Server is a powerful tool for accessing and analyzing financial market data. Here's how you can get started with it.

✨ Features

• Access financial market data from China and around the world through AKShare.
• Integrate with Claude Desktop via the MCP protocol.
• Support various financial data queries and analyses.

📦 Installation

Using uv (Recommended)

# Clone the repository
git clone https://github.com/yourusername/akshare_mcp_server.git
cd akshare_mcp_server

# Create and activate a virtual environment
python -m venv venv
source venv/bin/activate  # Use 'venv\Scripts\activate' on Windows

# Install dependencies using uv
uv pip install -e .

Using pip

# Clone the repository
git clone https://github.com/yourusername/akshare_mcp_server.git
cd akshare_mcp_server

# Create and activate a virtual environment
python -m venv venv
source venv/bin/activate  # Use 'venv\Scripts\activate' on Windows

# Install dependencies
pip install -e .

💻 Usage Examples

Running the Server

# Activate the virtual environment
source venv/bin/activate  # Use 'venv\Scripts\activate' on Windows

# Start the server
python run_server.py

Integrating with Claude Desktop

1. Add the following configuration to your Claude Desktop configuration file:

"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. Restart Claude Desktop.
3. Select the AKShare MCP Server from the available tools.

📚 Documentation

Available Tools

The AKShare MCP Server offers the following tools:

• Stock data query
• Fund data query
• Bond data query
• Futures data query
• Foreign exchange data query
• Macroeconomic data query
• And many more...

Adding New Tools

To add a new tool to the MCP Server, follow these steps:

1. Add a new API function in src/mcp_server_akshare/api.py:

async def fetch_new_data_function(param1: str, param2: str = "default") -> List[Dict[str, Any]]:
    """
    Fetch new data type.
    
    Args:
        param1: Describe parameter 1
        param2: Describe parameter 2 (optional)
    """
    try:
        df = ak.akshare_function_name(param1=param1, param2=param2)
        return dataframe_to_dict(df)  # Assume df is a DataFrame object
    except Exception as e:
        raise ValueError(f"Error fetching data: {str(e)}")

2. Register the new function in 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):
        # Implement your command logic here
        pass

    server.commands.append(new_command)

3. Import the new function in src/mcp_server_akshare/__init__.py:

from .api import fetch_new_data_function, register_new_function

# Register the new function
register_new_function()

4. Restart the server to apply the changes

Development Information

Code Structure

• src/mcp_server_akshare/: Contains the core implementation of the MCP Server.
• src/mcp_server_akshare/api.py: Defines the interface with AKShare and data processing logic.
• src/mcp_server_akshare/server.py: Implements the main logic of the MCP Server.
• src/mcp_server_akshare/commands/: Contains the implementation of various commands.

Contribution Guidelines

1. Ensure that all tests pass before submitting your code.
2. Follow the PEP8 coding style.
3. Provide detailed documentation.

Running with Docker

# Build the image
docker build -t akshare-mcp-server .

# Start the container
docker run -p 8000:8000 --name akshare-mcp-server akshare-mcp-server

📄 License

This project is licensed under the MIT License.