内容
# @quikrun/mcp
适用于 [QuikRun](https://quik.run) 的 [模型上下文协议](https://modelcontextprotocol.io) 服务器。它允许 AI 代理（Claude Desktop、Cursor 和其他 MCP 客户端）管理您的 QuikRun 代码片段 — 列出、读取、创建、编辑、运行、部署、复制和删除 — 通过封装 QuikRun REST API。
## 要求
- Node.js 20 或更新版本
- QuikRun 账户和 API 令牌
## 获取令牌
1. 在 [quik.run](https://quik.run) 登录。
2. 进入 **仪表盘 → 令牌**。
3. 创建一个新的令牌。它看起来像 `quik_<keyId>_<secret>`。
4. 复制它 — 您将在 MCP 客户端配置中将其粘贴为 `QUIKRUN_TOKEN`。
## Claude Desktop 设置
将以下内容添加到您的 `claude_desktop_config.json`：
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
```json
{
"mcpServers": {
"quikrun": {
"command": "npx",
"args": ["-y", "@quikrun/mcp"],
"env": {
"QUIKRUN_TOKEN": "quik_您的KeyId_您的Secret"
}
}
}
}
```
重启 Claude Desktop。QuikRun 工具将出现在工具菜单中。
### 可选：自托管 API
使用 `QUIKRUN_API_URL` 将服务器指向不同的 QuikRun API 主机（默认为 `https://api.quik.run`）：
```json
"env": {
"QUIKRUN_TOKEN": "quik_您的KeyId_您的Secret",
"QUIKRUN_API_URL": "https://api.quik.run"
}
```
## 工具
| 工具 | 功能 |
| --- | --- |
| `list_snippets` | 列出所有代码片段，附带简要摘要。 |
| `get_snippet` | 获取一个代码片段的元数据和完整源代码。 |
| `create_snippet` | 创建一个代码片段（可选名称、语言、提示）。 |
| `update_snippet_code` | 将源代码保存到代码片段的草稿中。 |
| `run_snippet` | 运行代码片段并返回输出、响应和日志。 |
| `deploy_snippet` | 发布当前草稿为实时版本。 |
| `update_snippet` | 更新名称、可见性、语言或运行时。 |
| `duplicate_snippet` | 复制代码片段。 |
| `delete_snippet` | 永久删除代码片段（破坏性）。 |
## 开发
```bash
npm install
npm run typecheck # 类型检查，不生成编译文件
npm run build # 编译到 dist/
npm run dev # 从源代码运行，带 tsx
```
## 许可证
MIT
