thegraph-mcp

What is TheGraph MCP Server?

TheGraph MCP Server is an MCP (Multi-Chain Protocol) server designed to empower AI agents with access to indexed blockchain data from The Graph. It acts as a bridge, allowing AI to understand and interact with vast amounts of on-chain information.

How to Use TheGraph MCP Server

1. Clone the Repository: Begin by cloning the project repository from GitHub:

   git clone https://https://github.com/kukapay/thegraph-mcp.git
   

2. Client Configuration: Configure your client to integrate with thegraph-mcp by adding the following to your client configuration, adjusting the path/to/thegraph-mcp to your cloned repository location and replacing your_api_key_here with your actual The Graph API key:

   {
     "mcpServers": {
       "thegraph-mcp": {
         "command": "uv",
         "args": ["--directory", "path/to/thegraph-mcp", "run", "main.py"],
         "env": {
           "THEGRAPH_API_KEY": "your_api_key_here"
         }
       }
     }
   }
   

Key Features of TheGraph MCP Server

• getSubgraphSchema Tool: Fetches the schema of a specified subgraph, providing AI agents with the necessary context to generate accurate GraphQL queries. It supports both human-readable GraphQL schema and JSON schema output.
• querySubgraph Tool: Executes GraphQL queries against a specified subgraph. This allows AI agents to retrieve specific blockchain data, and also supports manual query crafting.
• AI Agent Integration: Specifically designed to power AI agents, enabling them to interact with and analyze blockchain data effectively.
• The Graph Integration: Leverages The Graph's indexing capabilities to provide structured and easily queryable blockchain data.

Use Cases of TheGraph MCP Server

• Blockchain Data Analysis: AI agents can analyze trading volumes, liquidity, and other on-chain metrics from various subgraphs.
• Decentralized Application (dApp) Development: Developers can use AI agents powered by this server to understand and interact with dApp data models.
• Automated Trading Strategies: AI can be used to identify unusual trading patterns or compare asset liquidity for automated trading decisions.
• Smart Contract Interaction: AI agents can understand smart contract schemas and generate queries to interact with them.
• Research and Development: Researchers can leverage AI to explore and analyze vast datasets from different blockchain protocols.

FAQ about TheGraph MCP Server

Q: What is an MCP server? A: An MCP (Multi-Chain Protocol) server facilitates communication and data exchange across different blockchain networks or data sources, in this case, providing blockchain data to AI agents.

Q: Do I need an API key for The Graph? A: Yes, you will need a The Graph API key, which should be set as an environment variable (THEGRAPH_API_KEY) in your client configuration.

Q: Can I manually write GraphQL queries? A: Yes, while the server is designed for AI-generated queries, you can also manually craft and execute your own GraphQL queries using the querySubgraph tool.

Q: What kind of data can AI agents access? A: AI agents can access any indexed blockchain data available through The Graph subgraphs, including but not limited to trading volumes, liquidity, token information, and transaction details.

Q: Is this project open source? A: Yes, TheGraph MCP Server is open-source and licensed under the MIT License.

TheGraph MCP Server

An MCP server that powers AI agents with indexed blockchain data from The Graph.

Available Tools

1. getSubgraphSchema

Fetches the schema of a specified subgraph, providing AI agents with the context needed to generate GraphQL queries.

Parameters:

• subgraphId: The subgraph ID (e.g., "QmZBQcF...")
• asText: Output format flag
  • true: Returns human-readable GraphQL schema
  • false: Returns JSON schema (default)

2. querySubgraph

Executes GraphQL queries against a specified subgraph. While queries are typically generated by AI, you can also manually craft your own.

Parameters:

• subgraphId: The subgraph ID
• query: GraphQL query string

Installation

1. Clone the Repository

   git clone https://github.com/kukapay/thegraph-mcp.git
   

2. Client Configuration

   {
     "mcpServers": {
       "thegraph-mcp": {
         "command": "uv",
         "args": ["--directory", "path/to/thegraph-mcp", "run", "main.py"],
         "env": {
           "THEGRAPH_API_KEY": "your_api_key_here"
         }
       }
     }
   }
   

Example Prompts

Here are some natural language prompts to trigger the tools:

Schema Queries

• "Show me the schema for subgraph QmZBQcF... in a readable format"
• "What's the structure of the QmZBQcF... subgraph? Please display it in GraphQL format"
• "I need to understand the data model of subgraph QmZBQcF..., can you fetch its schema?"

Data Queries

• "Find the top 5 tokens by trading volume in the last 24 hours from subgraph QmZBQcF..."
• "Show me all pairs with liquidity greater than 1 million USD in subgraph QmZBQcF..."
• "Get the latest 10 swap events from the QmZBQcF... subgraph, including token symbols and amounts"

Analysis Tasks

• "Analyze the trading volume of USDT pairs in the last week using subgraph QmZBQcF..."
• "Compare the liquidity of ETH and USDC pairs in subgraph QmZBQcF..."
• "Find unusual trading patterns in the last 24 hours from subgraph QmZBQcF..."

Combined Tasks

• "First get the schema of QmZBQcF..., then help me write a query to find high-value transactions"
• "Check the schema of QmZBQcF... and tell me what fields are available for querying token prices"
• "Using subgraph QmZBQcF..., analyze the market impact of large trades by first understanding the schema and then querying relevant events"

License

This project is licensed under the MIT License. See the LICENSE file for details.