# DebugAI docs

> DebugAI finds the root cause of an error by reading your project, and answers with up to three ranked fixes you review as a diff. It runs as a VS Code extension (also on Open VSX for Cursor, Windsurf and VSCodium), as an MCP server for AI coding agents (npx -y @debugai/mcp setup), and as a plugin for ChatGPT and Codex.

Every page below is also served as Markdown: add .md to its address, for example https://docs.debugai.io/quickstart/vscode.md. The whole site in one file: https://docs.debugai.io/llms-full.txt. Product facts, pricing and the company: https://debugai.io/llms.txt.

- **Get started**
- [Start here](https://docs.debugai.io/): Set up DebugAI where you write code, debug your first error, and learn to read what it tells you.
- [VS Code quickstart](https://docs.debugai.io/quickstart/vscode): Install the extension, sign in, index your project and debug your first error.
- [Cursor, Windsurf, VSCodium](https://docs.debugai.io/quickstart/cursor-windsurf-vscodium): Install DebugAI from Open VSX in a VS Code fork, then sign in, index and debug exactly as in VS Code.
- [AI agents quickstart](https://docs.debugai.io/quickstart/agents): One command signs you in and adds DebugAI to Claude Code, Cursor, Windsurf and every other MCP client it finds.
- [ChatGPT and Codex](https://docs.debugai.io/quickstart/chatgpt-codex): Connect the DebugAI plugin to ChatGPT or Codex and sign in with your DebugAI account. Nothing to install.
- [Your first debug](https://docs.debugai.io/first-debug): A three-file project with a planted bug, where the line that crashes is not the line that is wrong. Watch DebugAI trace it.

- **Use DebugAI**
- [Index your project](https://docs.debugai.io/guides/index-your-project): Let DebugAI read your project once, so an answer can name the file that broke and not only the file that crashed.
- [Debug an error](https://docs.debugai.io/guides/debug-an-error): Send an error to DebugAI from the terminal, the editor or a pasted stack trace, and know exactly what goes with it.
- [Read a result](https://docs.debugai.io/guides/read-a-result): Know what each part of the results panel means, how far to trust a fix, and what to do when an answer comes back empty.
- [Apply and undo a fix](https://docs.debugai.io/guides/apply-and-undo): Preview a fix as a diff, apply it to your file, and take it back if it was wrong.
- [Proactive Scan](https://docs.debugai.io/guides/proactive-scan): Have DebugAI read the files you are working on and report defects it can prove against your source, before they turn into errors.
- [Work with your agent](https://docs.debugai.io/guides/work-with-your-agent): Give your coding agent a loop that checks project memory before it guesses, debugs what is new, and records what worked.
- [Debug in Browser](https://docs.debugai.io/guides/debug-in-browser): Catch the errors your terminal never shows, from a frontend running in a browser that VS Code launches, and debug them where they happen.
- [The dashboard](https://docs.debugai.io/guides/dashboard): Find your usage, your key, your debug history and a direct line to the person who builds DebugAI on debugai.io.

- **Connect an agent**
- [Claude Code](https://docs.debugai.io/agents/claude-code): Add the DebugAI tools to Claude Code with one command, and a hook that checks every failed command against your project's memory.
- [Cursor](https://docs.debugai.io/agents/cursor): Give Cursor's agent the DebugAI tools with one command, alongside or instead of the editor extension.
- [Windsurf](https://docs.debugai.io/agents/windsurf): Give Windsurf's agent the DebugAI tools with one command, alongside or instead of the editor extension.
- [Claude Desktop](https://docs.debugai.io/agents/claude-desktop): Add the DebugAI tools to the Claude Desktop app with one command, then tell it which project you mean.
- [Zed](https://docs.debugai.io/agents/zed): Give Zed's agent the DebugAI tools with one command, or one entry in your Zed settings.
- [Gemini CLI](https://docs.debugai.io/agents/gemini-cli): Add the DebugAI tools to Gemini CLI with one command.
- [Cline](https://docs.debugai.io/agents/cline): Add the DebugAI tools to Cline in VS Code with one command.
- [VS Code agent mode](https://docs.debugai.io/agents/vscode-agent-mode): With the DebugAI extension installed, VS Code's agent mode already has the DebugAI tools. Nothing else to install.
- [Other MCP clients](https://docs.debugai.io/agents/other-clients): Add DebugAI to any MCP client that runs local servers, with one sign-in and one config entry.

- **Troubleshooting**
- [Sign-in and keys](https://docs.debugai.io/troubleshooting/sign-in): Every sign-in, key and connection message in the editor, what it means and what to do about it.
- [Indexing problems](https://docs.debugai.io/troubleshooting/indexing): What each indexing message means, why a file was left out, and how to finish an index that stopped early.
- [Answers and limits](https://docs.debugai.io/troubleshooting/answers): When a debug comes back thin, refused or not at all, and what each limit message means.
- [MCP server problems](https://docs.debugai.io/troubleshooting/mcp): Run doctor first, then find the message it printed or the one your agent passed on.

- **Reference**
- [Commands and shortcuts](https://docs.debugai.io/reference/commands): Every command the VS Code extension adds, where each one appears, and the one default keyboard shortcut.
- [Settings](https://docs.debugai.io/reference/settings): The four settings the VS Code extension reads, their defaults, and what changes when you turn each one off.
- [MCP CLI](https://docs.debugai.io/reference/mcp-cli): Every command and flag of npx -y @debugai/mcp, what each one prints, the config files it writes, and the environment variables it reads.
- [MCP tools](https://docs.debugai.io/reference/mcp-tools): The tools each DebugAI MCP server gives your agent, every input they take, what they return, and the errors an agent can get back.
- [Plans and limits](https://docs.debugai.io/reference/limits): What each plan includes, what counts as a debug, when counters reset, and every size, rate and time limit DebugAI applies.
- [Changelog](https://debugai.io/changelog?src=docs)

- **How it works**
- [How DebugAI works](https://docs.debugai.io/concepts/how-it-works): What happens between an error on your screen and a fix in a diff, and what DebugAI does not do.
- [Verification](https://docs.debugai.io/concepts/verification): What Verified, Failed check and Not verified mean on a fix, what DebugAI can check, and why the third label exists.
- [Error memory](https://docs.debugai.io/concepts/error-memory): What DebugAI remembers about each error in a project, how a fix becomes remembered, and what makes it forget one.
- [What leaves your machine](https://docs.debugai.io/concepts/privacy): What each part of DebugAI sends, what it never sends, and where your key is kept.