JinDaGe - cairo-coder-mcp MCP Details

article

README

🚀 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 许可证。

cairo-coder-mcp