improve readme

Author: ozzafar

CHANGELOG.md

@@ -1,9 +1,75 @@
-# Change Log
+# Changelog
 
-All notable changes to the "DebugMCP" extension will be documented in this file.
+All notable changes to DebugMCP will be documented in this file.
 
-Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
+The format is based on [Keep a Changelog](https://keepachangelog.com/), and this project adheres to [Semantic Versioning](https://semver.org/).
 
-## [Unreleased]
+## [1.0.8] - 2025-03-14
 
-- Initial release
+### Added
+- Improved debug state reporting with richer context for AI agents
+- Named debug configuration support via `configurationName` parameter — use specific `launch.json` configurations by name
+
+### Fixed
+- Fixed debug state consistency issues during rapid step operations
+
+## [1.0.7] - 2025-02-XX
+
+### Changed
+- **Migrated from SSE to Streamable HTTP transport** — faster, more reliable MCP communication
+- Automatic migration of existing SSE configurations to new Streamable HTTP format
+- SSE backward compatibility maintained during transition period
+
+### Fixed
+- Dependency security updates (undici, express, body-parser, glob, js-yaml)
+
+### Internal
+- Migrated from `fastmcp` to official `@modelcontextprotocol/sdk`
+
+## [1.0.6] - 2025-01-XX
+
+### Added
+- **Agent auto-configuration popup** — automatically detects and registers with AI assistants (Cline, Copilot, Cursor)
+- **Comprehensive documentation** — added architecture docs, AGENTS.md, and troubleshooting guides
+- Language-specific debugging tips for Python, JavaScript, Java, C#, C++, and Go
+
+### Fixed
+- Fixed failure when `launch.json` contains comments (JSONC parsing)
+- Fixed C++ debug configuration issues
+- Fixed string equality comparison in breakpoint matching
+
+## [1.0.5] - 2025-01-XX
+
+### Added
+- **Debug specific test methods** — pass `testName` to debug individual unit tests
+- Clear all breakpoints tool for quick cleanup
+- Breakpoint listing tool to view all active breakpoints
+
+### Changed
+- Default launch configurations moved to lower priority (user configs preferred)
+- Improved MCP tool descriptions for better AI agent understanding
+
+## [1.0.4] - 2024-12-XX
+
+### Added
+- **C#/.NET debugging support**
+- Keep-alive for SSE sessions to prevent timeouts
+
+## [1.0.3] - 2024-12-XX
+
+### Added
+- Multi-language debugging support: Python, JavaScript/TypeScript, Java, C/C++, Go, Rust, PHP, Ruby
+- Breakpoint management (add, remove, list, clear all)
+- Step-through execution (step over, step into, step out)
+- Variable inspection with scope filtering (local, global, all)
+- Expression evaluation in debug context
+- Automatic debug configuration generation from file extensions
+- MCP server with SSE transport
+
+## [1.0.0] - 2024-12-XX
+
+### Added
+- Initial release
+- Core debugging capabilities via MCP protocol
+- VS Code Debug Adapter Protocol integration
+- Automatic MCP server startup on extension activation

README.md

@@ -192,6 +192,50 @@ Configure DebugMCP behavior in VSCode settings:
 | `debugmcp.timeoutInSeconds` | `180` | Timeout for debugging operations |
 
 
+## FAQ
+
+<details>
+<summary><b>Which AI assistants are supported?</b></summary>
+
+DebugMCP works with any MCP-compatible AI assistant, including **GitHub Copilot**, **Cline**, **Cursor**, **Roo Code**, **Windsurf**, and others. If your assistant supports the Model Context Protocol, it can use DebugMCP.
+</details>
+
+<details>
+<summary><b>Does it work with VS Code Remote SSH / Codespaces / WSL?</b></summary>
+
+Yes. DebugMCP runs as a VS Code extension with `extensionKind: workspace`, so it activates in the remote environment where your code lives. The MCP server runs on `localhost` within that remote context.
+</details>
+
+<details>
+<summary><b>Do I need to configure launch.json?</b></summary>
+
+No. DebugMCP automatically generates appropriate debug configurations based on the file's language/extension. If you have a `launch.json`, it will use matching configurations from there. You can also specify a configuration by name using the `configurationName` parameter.
+</details>
+
+<details>
+<summary><b>Is my code sent to any external service?</b></summary>
+
+No. DebugMCP runs 100% locally. The MCP server runs on `localhost`, and no code, variables, or debug data is sent to any external service. The AI assistant communicates with the MCP server entirely within your local machine.
+</details>
+
+<details>
+<summary><b>What if port 3001 is already in use?</b></summary>
+
+Change the port in VS Code settings: `"debugmcp.serverPort": 3002` (or any available port). Then update your AI assistant's MCP configuration to use the new port.
+</details>
+
+<details>
+<summary><b>Can I debug unit tests?</b></summary>
+
+Yes. Pass the `testName` parameter to `start_debugging` to debug a specific test method. DebugMCP will configure the debug session to run and pause at breakpoints within that test.
+</details>
+
+<details>
+<summary><b>Why is my AI assistant not using the debug tools?</b></summary>
+
+Make sure DebugMCP is registered in your AI assistant's MCP settings. The extension should auto-detect and offer to register itself. If not, see the [Manual MCP Server Registration](#manual-mcp-server-registration-optional) section. Also enable auto-approval for DebugMCP tools for a smoother workflow.
+</details>
+
 ## Troubleshooting
 
 ### Common Issues
@@ -271,6 +315,16 @@ trademarks or logos is subject to and must follow
 Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
 Any use of third-party trademarks or logos are subject to those third-party's policies.
 
+## ⭐ Star History
+
+<a href="https://star-history.com/#microsoft/DebugMCP&Date">
+ <picture>
+   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=microsoft/DebugMCP&type=Date&theme=dark" />
+   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=microsoft/DebugMCP&type=Date" />
+   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=microsoft/DebugMCP&type=Date" />
+ </picture>
+</a>
+
 ## License
 
 MIT License - See [LICENSE](LICENSE.txt) for details

package.json

@@ -38,6 +38,7 @@
     "AI",
     "Programming Languages"
   ],
+  "extensionDependencies": [],
   "repository": {
     "type": "git",
     "url": "https://github.com/microsoft/DebugMCP.git"