Skip to content

An MCP server for querying Solana transactions using natural language with Solscan API

Notifications You must be signed in to change notification settings

Valennmg/solscan-mcp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Solscan MCP 🚀

Solscan MCP

Welcome to Solscan MCP, an innovative server designed to query Solana transactions using natural language. This project leverages the Solscan API, making it easier for developers and users to interact with Solana's blockchain.

Table of Contents

Features 🌟

  • Natural Language Queries: Query Solana transactions using simple, natural language.
  • Fast and Efficient: Built with Rust for high performance.
  • Easy Integration: Simple API endpoints for easy integration into your applications.
  • Community Driven: Open-source contributions are welcome to enhance functionality.

Installation ⚙️

To get started with Solscan MCP, follow these steps:

  1. Clone the Repository:

    git clone https://github.com/Valennmg/solscan-mcp.git
    cd solscan-mcp
  2. Build the Project: Make sure you have Rust installed. If not, install it from rustup.rs.

    cargo build --release
  3. Run the Server: Execute the following command to start the server:

    ./target/release/solscan-mcp

For more detailed instructions, please check the Releases section.

Usage 📚

Once the server is running, you can start querying Solana transactions. Here’s how to use the API:

Example Queries

  • Get Transaction Details:

    What is the status of transaction ABC123?
    
  • Check Account Balance:

    How much SOL is in account XYZ456?
    

API Endpoints

Method Endpoint Description
GET /transaction/{id} Retrieve details for a specific transaction.
GET /account/{address} Get balance information for a specific account.

API Reference 📖

The API is designed to be intuitive. Here are some key endpoints:

Transaction Details

  • Endpoint: /transaction/{id}
  • Method: GET
  • Parameters:
    • id: The transaction ID to query.
  • Response: Returns a JSON object with transaction details.

Account Balance

  • Endpoint: /account/{address}
  • Method: GET
  • Parameters:
    • address: The Solana account address to query.
  • Response: Returns a JSON object with balance information.

Contributing 🤝

We welcome contributions to Solscan MCP. Here’s how you can help:

  1. Fork the Repository: Click on the "Fork" button at the top right of this page.
  2. Create a New Branch:
    git checkout -b feature/YourFeature
  3. Make Your Changes: Implement your feature or fix a bug.
  4. Commit Your Changes:
    git commit -m "Add your message here"
  5. Push to Your Branch:
    git push origin feature/YourFeature
  6. Create a Pull Request: Go to the "Pull Requests" tab and click "New Pull Request".

License 📜

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

Contact 📫

For questions or feedback, feel free to reach out:

Releases 📦

To download the latest version, visit the Releases section. Make sure to download the appropriate file and execute it to get started.

Acknowledgments 🙏

  • Thanks to the Solana community for their support.
  • Special thanks to the contributors who help make this project better.

Conclusion

Thank you for checking out Solscan MCP. We hope this tool makes it easier for you to interact with Solana's blockchain. Your contributions and feedback are valuable to us. Happy querying!

About

An MCP server for querying Solana transactions using natural language with Solscan API

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages