Skip to content

docs(readme): standardize format to match template #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CalvinAllen merged 1 commit into from
Jan 30, 2026
Merged

docs(readme): standardize format to match template #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
187 changes: 93 additions & 94 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,62 +1,76 @@
# 🔌 VSC as MCP

**🚀 Supercharge your AI coding assistants with VS Code's powerful language intelligence!**

A Visual Studio Code extension that exposes an MCP (Model Context Protocol) server, giving AI tools like Claude, Cursor, and others direct access to VS Code's semantic code understanding capabilities - go-to-definition, find references, completions, diagnostics, and so much more!
<p align="center">
<img src="https://raw.githubusercontent.com/CodingWithCalvin/VSC-MCPServer/main/resources/logo.png" alt="VSC as MCP Logo" width="128" height="128">
</p>

<h1 align="center">VSC as MCP</h1>

<p align="center">
<strong>Supercharge your AI coding assistants with VS Code's powerful language intelligence!</strong>
</p>

<p align="center">
<a href="https://github.com/CodingWithCalvin/VSC-MCPServer/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/CodingWithCalvin/VSC-MCPServer?style=for-the-badge" alt="License">
</a>
<a href="https://github.com/CodingWithCalvin/VSC-MCPServer/actions/workflows/build.yml">
<img src="https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VSC-MCPServer/build.yml?style=for-the-badge" alt="Build Status">
</a>
</p>

<p align="center">
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VSC-MCPServer">
<img src="https://img.shields.io/visual-studio-marketplace/v/CodingWithCalvin.VSC-MCPServer?style=for-the-badge" alt="Marketplace Version">
</a>
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VSC-MCPServer">
<img src="https://img.shields.io/visual-studio-marketplace/i/CodingWithCalvin.VSC-MCPServer?style=for-the-badge" alt="Marketplace Installations">
</a>
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VSC-MCPServer">
<img src="https://img.shields.io/visual-studio-marketplace/d/CodingWithCalvin.VSC-MCPServer?style=for-the-badge" alt="Marketplace Downloads">
</a>
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VSC-MCPServer">
<img src="https://img.shields.io/visual-studio-marketplace/r/CodingWithCalvin.VSC-MCPServer?style=for-the-badge" alt="Marketplace Rating">
</a>
</p>

---

[![License](https://img.shields.io/github/license/CodingWithCalvin/VSC-MCPServer?style=for-the-badge)](LICENSE)
[![Build Status](https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VSC-MCPServer/build.yml?style=for-the-badge)](https://github.com/CodingWithCalvin/VSC-MCPServer/actions/workflows/build.yml)

[![VS Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/CodingWithCalvin.VSC-MCPServer?style=for-the-badge&logo=visualstudiocode&logoColor=white)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VSC-MCPServer)
[![VS Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/CodingWithCalvin.VSC-MCPServer?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VSC-MCPServer)
[![VS Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/CodingWithCalvin.VSC-MCPServer?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VSC-MCPServer)
[![VS Marketplace Rating](https://img.shields.io/visual-studio-marketplace/r/CodingWithCalvin.VSC-MCPServer?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VSC-MCPServer)

---
A Visual Studio Code extension that exposes an MCP (Model Context Protocol) server, giving AI tools like Claude, Cursor, and others direct access to VS Code's semantic code understanding capabilities - go-to-definition, find references, completions, diagnostics, and so much more!

## ✨ Features
## Features

- **🧠 Full Language Intelligence** - Access VS Code's language server features via MCP tools
- **📁 Workspace Aware** - Works on individual files or full project contexts
- **🔗 URI Protocol Handler** - Launch VS Code via `vscode://codingwithcalvin.mcp/...`
- **⚡ Auto-start** - MCP server starts automatically when VS Code launches
- **🔒 Secure by Default** - Binds only to localhost, no external access
- **Full Language Intelligence** - Access VS Code's language server features via MCP tools
- **Workspace Aware** - Works on individual files or full project contexts
- **URI Protocol Handler** - Launch VS Code via `vscode://codingwithcalvin.mcp/...`
- **Auto-start** - MCP server starts automatically when VS Code launches
- **Secure by Default** - Binds only to localhost, no external access

---

## 🛠️ Available Tools
## Available Tools

| Tool | Description |
|------|-------------|
| 📂 `vscode_open_folder` | Open a workspace folder |
| 📋 `vscode_get_open_folders` | Get currently open workspace folder(s) |
| 🏷️ `vscode_document_symbols` | Get all symbols in a document |
| 🔍 `vscode_workspace_symbols` | Search symbols across the workspace |
| 🎯 `vscode_go_to_definition` | Find symbol definitions |
| 🔗 `vscode_find_references` | Find all references to a symbol |
| 💡 `vscode_hover_info` | Get type info and documentation |
| ⚠️ `vscode_diagnostics` | Get errors and warnings |
| 📞 `vscode_call_hierarchy` | Get incoming/outgoing calls |
| ✏️ `vscode_completions` | Get code completions at a position |
| 📝 `vscode_signature_help` | Get function signature help |
| 🏗️ `vscode_type_hierarchy` | Get type hierarchy information |
| 🔧 `vscode_code_actions` | Get available code actions/quick fixes |
| 🎨 `vscode_format_document` | Format an entire document |
| ✂️ `vscode_format_range` | Format a specific range |
| 📦 `vscode_organize_imports` | Organize imports in a document |
| ✏️ `vscode_rename_symbol` | Rename a symbol across the workspace |
| 🔎 `vscode_workspace_file_search` | Search for files by pattern |
| 📄 `vscode_workspace_text_search` | Search for text across files |

---

## 📦 Installation

### From VS Code Marketplace

[![VS Marketplace](https://img.shields.io/badge/VS%20Code%20Marketplace-MCP%20Server-007ACC?style=for-the-badge&logo=visualstudiocode&logoColor=white)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VSC-MCPServer)
| `vscode_open_folder` | Open a workspace folder |
| `vscode_get_open_folders` | Get currently open workspace folder(s) |
| `vscode_document_symbols` | Get all symbols in a document |
| `vscode_workspace_symbols` | Search symbols across the workspace |
| `vscode_go_to_definition` | Find symbol definitions |
| `vscode_find_references` | Find all references to a symbol |
| `vscode_hover_info` | Get type info and documentation |
| `vscode_diagnostics` | Get errors and warnings |
| `vscode_call_hierarchy` | Get incoming/outgoing calls |
| `vscode_completions` | Get code completions at a position |
| `vscode_signature_help` | Get function signature help |
| `vscode_type_hierarchy` | Get type hierarchy information |
| `vscode_code_actions` | Get available code actions/quick fixes |
| `vscode_format_document` | Format an entire document |
| `vscode_format_range` | Format a specific range |
| `vscode_organize_imports` | Organize imports in a document |
| `vscode_rename_symbol` | Rename a symbol across the workspace |
| `vscode_workspace_file_search` | Search for files by pattern |
| `vscode_workspace_text_search` | Search for text across files |

## Installation

### VS Code Marketplace

1. Open VS Code
2. Go to **Extensions** (Ctrl+Shift+X)
Expand All @@ -71,9 +85,7 @@ Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCal
code --install-extension CodingWithCalvin.VSC-MCPServer.vsix
```

---

## 🎯 Usage
## Usage

The MCP server starts automatically when VS Code launches! Just configure your AI tool to connect:

Expand Down Expand Up @@ -102,71 +114,58 @@ vscode://codingwithcalvin.mcp/start?port=4000 # Start on specific port
vscode://codingwithcalvin.mcp/open?folder=/path/to/dir # Open folder and start
```

---

## ⚙️ Configuration
## Configuration

| Setting | Default | Description |
|---------|---------|-------------|
| `codingwithcalvin.mcp.autoStart` | `true` | 🚀 Auto-start server on VS Code launch |
| `codingwithcalvin.mcp.port` | `4000` | 🔌 MCP server port |
| `codingwithcalvin.mcp.bindAddress` | `127.0.0.1` | 🔒 Bind address (localhost only) |
| `codingwithcalvin.mcp.autoStart` | `true` | Auto-start server on VS Code launch |
| `codingwithcalvin.mcp.port` | `4000` | MCP server port |
| `codingwithcalvin.mcp.bindAddress` | `127.0.0.1` | Bind address (localhost only) |

---

## 💻 Commands
## Commands

Access these from the Command Palette (Ctrl+Shift+P):

- **▶️ MCP Server: Start** - Start the MCP server
- **⏹️ MCP Server: Stop** - Stop the MCP server
- **🔄 MCP Server: Restart** - Restart the MCP server
- **📋 MCP Server: Show Available Tools** - View all available MCP tools

---

## 🔒 Security

- 🏠 **Localhost Only** - Binds only to `127.0.0.1`
- 🛡️ **DNS Rebinding Protection** - Validates Host header
- ✅ **Same-machine Trusted** - No authentication required for local access
- **MCP Server: Start** - Start the MCP server
- **MCP Server: Stop** - Stop the MCP server
- **MCP Server: Restart** - Restart the MCP server
- **MCP Server: Show Available Tools** - View all available MCP tools

---
## Security

## 📋 Requirements
- **Localhost Only** - Binds only to `127.0.0.1`
- **DNS Rebinding Protection** - Validates Host header
- **Same-machine Trusted** - No authentication required for local access

- 💻 Visual Studio Code 1.85.0 or later
- 🟢 Node.js (bundled with VS Code)
## Requirements

---
- Visual Studio Code 1.85.0 or later
- Node.js (bundled with VS Code)

## 🤝 Contributing
## Contributing

Contributions are welcome! Whether it's bug reports, feature requests, or pull requests - all feedback helps make this extension better. 💪
Contributions are welcome! Whether it's bug reports, feature requests, or pull requests - all feedback helps make this extension better.

### Development Setup

1. 🍴 Clone the repository
2. 📦 Run `npm install`
3. 🔨 Run `npm run build`
4. ▶️ Press F5 to launch the Extension Development Host
1. Clone the repository
2. Run `npm install`
3. Run `npm run build`
4. Press F5 to launch the Extension Development Host

---

## 📄 License
## License

This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

---

## 👥 Contributors
## Contributors

<!-- readme: contributors -start -->
[![CalvinAllen](https://avatars.githubusercontent.com/u/41448698?v=4&s=64)](https://github.com/CalvinAllen)
<!-- readme: contributors -end -->

---

**⭐ If you find VSC as MCP useful, please consider giving it a star! ⭐**

*Made with ❤️ for the VS Code community by Coding With Calvin*
<p align="center">
Made with ❤️ by <a href="https://github.com/CodingWithCalvin">Coding With Calvin</a>
</p>