My MCP Server 3rt

🚀 MCP Cryptocurrency Protocol

The MCP (Model Context Protocol) cryptocurrency protocol is an efficient application protocol that aims to implement the server-side interface of the model context protocol through FastMCP. This protocol combines the powerful capabilities of the TimescaleDB time-series database and the CCXT cryptocurrency trading library, providing a unified platform for cryptocurrency market data, news analysis, and AI-driven insights.

🚀 Quick Start

📦 Installation

Quick Installation

Install with a single command using pip:

pip install mcp-crypto

Start the Service

Start the MCP cryptocurrency server:

python -m mcp.crypto serve --host localhost --port 8000

✨ Features

Core Components

1. TimescaleDB Database Integration

• Time-Series Data Storage: Utilize TimescaleDB's hypertables to store and query historical market data.
• Efficient Querying: Support complex queries by time period, asset, and multiple metrics, with high read and write performance.

2. CCXT Cryptocurrency Trading Library

• Multi-Exchange Support: Connect to over 100+ major cryptocurrency exchanges to obtain real-time and historical market data.
• Unified Interface: Retrieve market information, order books, and trading data from all connected exchanges through a standard API.

3. MCP Protocol Implementation

• Model Context Protocol: Implemented based on FastMCP, providing a unified interface for connecting AI models and cryptocurrency data sources.
• Resources and Tools:
  • Resources: Provide market data, asset lists, news data, etc.
  • Tools: Include market analysis tools, news sentiment analysis tools, and trading strategy generators.

4. uv Package Manager

• Dependency Management: uv is a high-performance Python package manager used to quickly add and synchronize project dependencies.
• Efficient Management:

# Add a new dependency
uv add package_name

# Synchronize all dependencies
uv pip sync

# Generate a dependency lock file
uv pip compile -o uv.lock

Core Functions

• Market Data: Obtain real-time and historical market data, supporting custom time period queries.
• News Analysis: Provide cryptocurrency-related news insights through RSS feed aggregation and sentiment analysis.
• AI-Driven Insights: Connect AI models using the MCP protocol to generate trading suggestions and market forecasts.

Resources and Tools

Resources

• symbols://list: Get all supported cryptocurrency symbols.
• market_data://{symbol}: Get real-time market data for a specific symbol.
• historical_data://{symbol}?timeframe={timeframe}&start={start}&end={end}: Query historical data by time period.
• news://recent: Get the latest news summaries.
• news://{source}: Get news by source.
• news://by-coin/{symbol}: Get relevant news by cryptocurrency symbol.

Tools

• Market Analysis Tools: Analyze market trends and generate trading suggestions.
• News Sentiment Analysis: Evaluate the impact of news on the market and provide insights.
• Trading Strategy Generator: Generate trading strategies based on data and model outputs.

💻 Usage Examples

Basic Usage

Server-Side Development

Create a custom MCP server:

from mcp.crypto.server import MCPServer

# Create a simple MCP server
server = MCPServer(host="localhost", port=8000)

# Define a new resource
@server.resource("example://test")
def get_example_resource():
    return {"message": "Hello, MCP!"}

# Start the server
if __name__ == "__main__":
    server.start()

Client-Side Usage

Access resources and tools through the MCP client:

from mcp import Client

# Connect to the local server
client = Client("http://localhost:8000")

# Request market data
market_data_response = await client.query(
    inputs=["BTC/USD"],
    resources=["market_data:BTC/USD"]
)
print(market_data_response.outputs)

# Use the news analysis tool
news_analysis_response = await client.query(
    inputs=["BTC/USD"],
    tools=["news_analysis"]
)
print(news_analysis_response.outputs)

Advanced Usage

Create a Custom Resource

from mcp.crypto.server import MCPServer

# Create a custom resource
class ExampleResource:
    def get(self, symbol):
        return f"Example data for {symbol}"

# Register the resource to the server
server.add_resource("example://custom", ExampleResource())

Generate a Trading Strategy Using Tools

from mcp.crypto.tools import NewsAnalyzer

# Initialize the news analysis tool
news_analyzer = NewsAnalyzer()

# Analyze news and generate a strategy
analysis = news_analyzer.analyze("latest BTC news")
print(analysis.strategy)

📚 Documentation

Server-Side Development Guide

1. Create a Custom Resource: Define a new resource class, implement the get method, and register it with the server.
2. Add a Tool: Create a new tool class, implement the analyze method, and register it with the server.

Client-Side Usage Guide

1. Connect to the Server: Connect to the MCP server through the Client class.
2. Request Resources and Tools: Call the query method to obtain the required data and analysis results.

Example Code

from mcp import Client

# Connect to the local server
client = Client("http://localhost:8000")

# Request real-time market data
market_data_response = await client.query(
    inputs=["BTC/USD"],
    resources=["market_data:BTC/USD"]
)
print(market_data_response.outputs)

# Use the news analysis tool to obtain insights
news_insight = await client.query(
    inputs=["ETH/USD"],
    tools=["news_analysis"]
)
print(news_insight.outputs)

Run the Example

Start the server:

python -m mcp.crypto serve --host localhost --port 8000

Run the client script:

python client_script.py

Further Reading

• MCP Protocol Documentation: Gain an in-depth understanding of the working principles and interface definitions of the MCP protocol.
• TimescaleDB Documentation: Learn how to efficiently store and query time-series data in TimescaleDB.
• CCXT Documentation: Explore more methods for integrating cryptocurrency exchanges and obtaining data.

🤝 Project Contribution

Contribution Guidelines

Community contributions are welcome! Please refer to CONTRIBUTING.md for more information.

📄 License

This project is licensed under the MIT License. The full text of the license is as follows:

MIT License

Copyright (c) 2023 MCP-Crypto Authors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

🛠️ Project Maintenance

Maintenance Team

• Core Developers:
  • [Your Name] (Your GitHub)
  • [Other Developer Name] (GitHub)

Contact Information

• Mailing List: project-discussion@mcp-crypto.org
• GitHub Repository: https://github.com/mcp-crypto/mcp-crypto

🙏 Acknowledgments

Thank you to all contributors and community members for your support in making the MCP cryptocurrency protocol better.