Starknet MCP Server

🚀 Starknet Model Context Protocol Server

This is an implementation of the Model Context Protocol on Starknet. This server enables AI assistants to interact with the Starknet blockchain, supporting various operations such as checking balances, resolving addresses, and querying transactions.

🚀 Quick Start

import { createServer } from 'starknet-mcp-server'

async function main() {
  const server = await createServer()
  await server.start(3000)
  console.log('Server has started. Visit http://localhost:3000')
}

main().catch(console.error)

✨ Features

Supported Blockchain Protocols

• Starknet Mainnet
• Starknet Testnet

Resource Architecture

{
  chains: {
    // Blockchain configuration information
    resources: {
      // List of available resources
      tools: {
        // Set of provided tools
      }
    }
  }
}

Toolset

Example Tool: Query Address Balance

server.tool({
  name: 'starknet_balance',
  description: 'Query the ETH and token balances of a Starknet address',
  params: {
    address: string().describe('Target address')
  },
  async run({ address }) {
    return await balance getAddress(address)
  }
})

📦 Installation

npm install starknet-mcp-server

💻 Usage Examples

• Query address balance: balance of 0x04d07e40e93398ed3c76981e449d3446f7c4e52aac5b3e8a37d7b0ca30845a5d
• Resolve address to Starknet ID: lookup starknet_id for 0x04d07e40e93398ed3c76981e449d3446f7c4e52aac5b3e8a37d7b0ca30845a5d
• Query the latest block: latest block on starknet mainnet

⚠️ Important Note

• Private keys are only used for signing transactions and will not be stored on the server.
• All inputs need to be strictly verified.
• Use HTTPS to protect network communication.

🔧 Technical Details

Directory Structure

src/
├── chains/                 # Blockchain configuration files
├── resources/             # Definitions of available resources
├── tools/                 # Set of provided tools
└── server.ts              # Main server program

Development Specifications

• Use name to identify tools.
• Configure environment variables:

  CHAINS=starknet-mainnet,starknet-testnet
  CONTRACT_ADDRESS=0x mainnet_address,0x testnet_address
  

📚 Documentation

• Starknet.js Documentation
• Model Context Protocol Documentation

📄 License

MIT License