<div align="center"> <img src="assets/debugssy_logo.png" alt="Debugssy Logo" width="150" />

Debugssy

基于AI的VS Code调试工具

通过任何AI助手使用模型上下文协议（MCP）控制您的调试器。

立即安装 · 文档 · 报告错误 · 请求功能

</div>

---

🎯 概述

停止点击调试器。 Debugssy允许您通过连接您的AI助手（如Cursor、GitHub Copilot、Claude Desktop）到VS Code的调试引擎来使用自然语言进行调试。

💬 您：“调试为什么用户登录时会得到null”

🤖 AI：设置断点 → 检查变量 → 追踪执行 →
      发现数据库查询中缺少WHERE子句 → 修复！⚡

主要特性：

• 🔴 智能断点，带有条件、计数和日志消息
• 🔍 变量检查，在执行过程中的任意位置
• 📊 调用栈分析，追踪执行流程
• ⚡ 两种自动化模式 - 您控制或AI控制
• 🔒 设计安全 - 仅限本地主机，遵循MCP安全标准

推荐的AI模型：Claude 4.5 Haiku 或 Grok 4 Fast（快速、智能且成本效益高）

---

📑 目录

<details open> <summary><b>入门指南</b></summary>

• 快速开始
• 安装
• 配置
• 首次调试会话

</details> <details> <summary><b>功能与工具</b></summary>

• 自动化模式
• 可用工具
• MCP提示
• MCP资源

</details> <details> <summary><b>技术文档</b></summary>

• 架构
• MCP服务器实现
• 安全模型
• API参考
• 性能与优化

</details> <details> <summary><b>开发与贡献</b></summary>

• 从源代码构建
• 项目结构
• 贡献
• 已知限制

</details> <details> <summary><b>支持与资源</b></summary>

• 故障排除
• 常见问题解答
• 附加文档
• 支持此项目

</details>

---

🚀 快速开始

安装

选项 1：VS Code Marketplace（推荐）

# 在VS Code中：按Ctrl+Shift+X，搜索“Debugssy”，点击安装

或者从以下链接安装：

• VS Code Marketplace
• Open VSX Registry （适用于 VSCodium, Gitpod等）

选项 2：手动安装（VSIX）

# 从GitHub Releases下载
wget https://github.com/gmaynez/debugssy/releases/latest/download/debugssy-<版本>.vsix

# 安装
code --install-extension debugssy-<版本>.vsix

选项 3：开发模式

git clone https://github.com/gmaynez/debugssy.git
cd debugssy
npm install
# 在VS Code中按F5启动扩展开发主机

连接您的AI助手

一键设置链接：

AI 助手	设置链接	手动配置
GitHub Copilot	在VS Code中安装	见下文
Cursor	在Cursor中安装	见下文
Claude Desktop	仅手动	见下文

<details id="github-copilot-configuration"> <summary><b>GitHub Copilot 配置</b></summary>

添加到VS Code settings.json：

{
  "github.copilot.chat.mcp.servers": {
    "debugssy": {
      "url": "http://localhost:3000/mcp"
    }
  }
}

⚠️ 注意：更改debugssy.automationLevel后重启VS Code以使Copilot看到更新的工具。

</details> <details id="cursor-configuration"> <summary><b>Cursor 配置</b></summary>

添加到~/.cursor/mcp.json：

{
  "mcpServers": {
    "debugssy": {
      "url": "http://localhost:3000/mcp"
    }
  }
}

</details> <details id="claude-desktop-configuration"> <summary><b>Claude Desktop 配置</b></summary>

添加到配置文件：

• Mac：~/Library/Application Support/Claude/claude_desktop_config.json
• Windows：%APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "debugssy": {
      "url": "http://localhost:3000/mcp"
    }
  }
}

</details>

首次调试会话

1. 启动调试您的应用程序在VS Code中（F5）
2. 告诉您的AI关于bug的信息：

   "调试为什么用户登录时会得到null"
   

3. 观看AI工作：
   • 自动设置断点
   • 检查变量
   • 追踪执行
   • 确定根本原因

小贴士：在您的AI聊天中键入/以查看引导式调试工作流（/debug-crash，/trace-variable等）

---

⚙️ 配置

VS Code 设置

通过文件 → 首选项 → 设置（搜索“debugssy”）访问：

设置	默认值	描述
debugssy.mcp.enabled	true	启用MCP服务器
debugssy.mcp.port	3000	服务器端口（如果被占用则更改）
debugssy.automationLevel	assisted	assisted或full
debugssy.waitForBreakpointTimeout	5000	超时时间（1秒-5分钟）
debugssy.allowStepOperations	false	允许全模式下的步进操作
debugssy.maxExpressionLength	100	最大表达式长度（安全性）
debugssy.expressionValidationLevel	moderate	表达式验证严格程度

<details> <summary><b>示例配置</b></summary>

{
  "debugssy.mcp.enabled": true,
  "debugssy.mcp.port": 3000,
 [...]