Skip to content

Graphfied/Cursor-Algorand

Repository files navigation

Algorand Devs MCP v1.1.0

Get the most up-to-date information, docs, and coding assistance when writing Algorand code and on-chain smart contracts (Programs). Now featuring AlgoKit 3.0 TypeScript support and enhanced performance!

🚀 What's New in v1.1.0

  • AlgoKit 3.0 Integration: Full TypeScript smart contract support with official templates
  • Enhanced Documentation: Powered by LLM dump from dev.algorand.co for stable, fast searches
  • SDK-Level Address Validation: Proper checksum verification using algosdk.isValidAddress()
  • Performance Improvements: In-memory caching (5-minute TTL) for faster responses
  • Network Normalization: Handles "MainNet", "MAINNET", etc. gracefully
  • Stricter Validation: Required parameters and additionalProperties: false for cleaner schemas
  • Updated URLs: All links point to the current dev.algorand.co portal

Features

This MCP server provides comprehensive Algorand development assistance including:

  • Documentation Access: Get the latest Algorand documentation via LLM dump
  • API Reference: Access Algorand REST API endpoints and methods
  • Smart Contract Examples: Get code examples in Python, JavaScript, Go, and TypeScript
  • Network Information: Check Algorand network status and details with caching
  • News & Updates: Stay updated with the latest Algorand ecosystem news
  • Address Validation: Validate Algorand addresses with proper checksum verification
  • Transaction Examples: Get examples for common transaction types including TypeScript
  • AlgoKit 3.0 Support: Comprehensive TypeScript development tools and templates
  • ARC References: Key Algorand Request for Comments standards and specifications
  • Health Monitoring: Server status, cache information, and system health
  • Configuration Access: Runtime settings, endpoints, and feature status

Installation

Prerequisites

  • Node.js 18.0.0 or higher
  • npm or yarn package manager

Setup

  1. Clone this repository:
git clone https://github.com/Graphfied/Cursor-Algorand.git
cd Cursor-Algorand
  1. Install dependencies:
npm install
  1. Build the project:
npm run build

Cursor Integration

Method 1: Direct Installation

  1. Open Cursor
  2. Go to Settings > Extensions > MCP
  3. Add a new MCP server with the following configuration:
{
  "mcpServers": {
    "algorand-devs-mcp": {
      "command": "node",
      "args": [
        "/path/to/Cursor-Algorand/dist/index.js/Cursor-Algorand/dist/index.js"
      ],
      "env": {}
    }
  }
}

Method 2: Using the Deep Link

Click this link to automatically configure the MCP in Cursor:

cursor://mcp/install?name=algorand-devs-mcp&command=node&args=[%22/path/to/algorand-devs-mcp/dist/index.js%22]

Replace /path/to/Cursor-Algorand with the actual path to your installation.

Usage

Once installed, you can use the following tools in Cursor:

Available Tools

  1. get_algorand_docs - Get Algorand documentation via LLM dump

    • Parameters: topic (optional), section (optional)
    • Features: Fast in-memory search, cached results
  2. get_algorand_api_reference - Get API reference

    • Parameters: endpoint (optional), method (optional)
    • Features: Updated dev.algorand.co URLs
  3. get_smart_contract_examples - Get smart contract examples

    • Parameters: language (optional), contract_type (optional)
    • Languages: Python, JavaScript, Go, TypeScript (AlgoKit 3.0)
    • Features: Reference-only TypeScript examples with official templates
  4. get_algorand_network_info - Get network information

    • Parameters: network (optional: mainnet, testnet, betanet)
    • Features: Cached results, network normalization, env-configurable endpoints
  5. get_latest_algorand_news - Get latest news

    • Parameters: category (optional)
    • Features: Updated with AlgoKit 3.0 announcements
  6. validate_algorand_address - Validate addresses with checksum

    • Parameters: address (required)
    • Features: SDK-level validation using algosdk.isValidAddress()
  7. get_transaction_examples - Get transaction examples

    • Parameters: transaction_type (optional), language (optional)
    • Languages: Python, JavaScript, Go, TypeScript (AlgoKit 3.0)
  8. get_algokit_info - Get AlgoKit 3.0 information and setup guides

    • Parameters: feature (optional: typescript, debugging, setup, migration)
    • Features: TypeScript support, visual debugging tools, CLI guides
  9. get_arc_refs - Get key ARC (Algorand Request for Comments) references

    • Parameters: None
    • Features: Essential ARCs (ARC-4, ARC-32, ARC-12, ARC-19, ARC-69)
  10. health_check - Get MCP health status and version information

    • Parameters: None
    • Features: Server status, cache info, available tools list
  11. get_config - Get MCP configuration and runtime settings

    • Parameters: None
    • Features: Version, cache TTL, endpoints, enabled features

Example Usage

Ask Cursor questions like:

  • "Show me Algorand smart contract examples in TypeScript"
  • "Get AlgoKit 3.0 setup guide and TypeScript support"
  • "Get the latest Algorand API documentation"
  • "Validate this Algorand address: ABC123..."
  • "Show me payment transaction examples in TypeScript"
  • "What's the current status of the Algorand mainnet?"
  • "How do I create an ASA using AlgoKit 3.0?"
  • "Show me AlgoKit debugging tools and features"
  • "Get key ARC references for Algorand development"
  • "Check the health status of the MCP server"
  • "Show me the current MCP configuration"

Development

Running in Development Mode

npm run dev

Building for Production

npm run build

Testing

npm test

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests if applicable
  5. Submit a pull request

License

MIT License - see LICENSE file for details.

Support

Changelog

v1.1.0 (Current)

  • AlgoKit 3.0 Integration: Full TypeScript smart contract support
  • Enhanced Documentation: LLM dump integration for stable, fast searches
  • SDK Address Validation: Proper checksum verification using algosdk.isValidAddress()
  • Performance Improvements: In-memory caching (5-minute TTL)
  • Network Normalization: Handles case variations gracefully
  • Stricter Validation: Required parameters and additionalProperties: false
  • Updated URLs: All links point to dev.algorand.co
  • New Tools: get_algokit_info, get_arc_refs, health_check, get_config
  • TypeScript Examples: Reference-only examples with official template links
  • ARC References: Key Algorand Request for Comments (ARC-4, ARC-32, ARC-12, ARC-19, ARC-69)
  • Health Monitoring: Server status and cache information
  • Configuration Access: Runtime settings and endpoint information

v1.0.0

  • Initial release
  • Basic MCP server implementation
  • Core Algorand development tools
  • Cursor integration support

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published