Cairo Coder MCP

🚀 Cairo Coder MCP Server

Cairo Coder MCP Server 是一個用於輔助 Cairo 和 Starknet 開發的模型上下文協議（MCP）服務器，它通過 Cairo Coder API 提供支持。

🚀 快速開始

可以使用 npx 直接啟動這個 MCP 服務器：

npx -y @kasarlabs/cairo-coder-mcp

✨ 主要特性

• 代碼編寫：生成智能合約和 Cairo 代碼。
• 代碼重構：改進和優化現有代碼。
• 功能實現：完成待辦事項並實現特定功能。
• 知識學習：獲取關於 Starknet 生態系統的上下文信息。
• 最佳實踐：根據 Cairo/Starknet 文檔獲得建議。

📦 安裝指南

前提條件

• Node.js >= 18
• npm 或 yarn

本地安裝

git clone <repository-url>
cd cairo-coder-mcp
npm install

可用腳本

npm run build    # 構建項目
npm run dev      # 以開發模式啟動
npm start        # 以生產模式啟動

💻 使用示例

基礎用法

使用 npx 啟動服務器：

npx -y @kasarlabs/cairo-coder-mcp

高級用法

模式 1：公共 Cairo Coder API（默認）

使用官方的 Cairo Coder API 和你的 API 密鑰。

環境變量：

• CAIRO_CODER_API_KEY：你的 Cairo Coder API 密鑰（必需）

MCP 客戶端設置：

{
  "mcpServers": {
    "cairo-coder": {
      "command": "npx",
      "args": ["-y", "@kasarlabs/cairo-coder-mcp"],
      "env": {
        "CAIRO_CODER_API_KEY": "your-api-key-here"
      }
    }
  }
}

模式 2：本地/自定義端點

使用本地或自定義的 Cairo Coder API 端點（無需 API 密鑰）。

環境變量：

• CAIRO_CODER_API_ENDPOINT：你的本地端點 URL（例如，"http://localhost:8000"）

MCP 客戶端設置：

{
  "mcpServers": {
    "cairo-coder": {
      "command": "npx",
      "args": ["-y", "@kasarlabs/cairo-coder-mcp"],
      "env": {
        "CAIRO_CODER_API_ENDPOINT": "http://localhost:8000"
      }
    }
  }
}

⚠️ 重要提示

使用 CAIRO_CODER_API_ENDPOINT 時，服務器會自動切換到本地模式，無需也不會使用 API 密鑰。

工具使用示例

assist_with_cairo

獲取 Cairo 和 Starknet 開發任務的幫助。

參數：

• query（字符串，必需）：你的 Cairo/Starknet 開發問題
• context（字符串，可選）：額外的上下文或代碼片段

示例：

// 簡單請求
{
  "query": "Write a simple Cairo contract that implements a counter"
}

// 帶上下文
{
  "query": "How can I optimize this contract?",
  "context": "#[starknet::contract]\nmod Counter {\n    // existing code here\n}"
}

📚 詳細文檔

獲得更好結果的提示

• 使用具體的查詢（例如，“使用 OpenZeppelin 構建 ERC20” 而不是僅 “ERC20”）
• 處理現有代碼時包含相關的代碼片段
• 提供必要的上下文以獲得更準確的響應

支持與貢獻

支持

對於問題和疑問：

• GitHub 問題：創建問題
• MCP 文檔：模型上下文協議

貢獻

歡迎貢獻代碼！提交 PR 之前請查看貢獻指南。

📄 許可證

本項目採用 MIT 許可證。