Skip to content

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

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 #28

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
71 changes: 48 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,46 @@
# 🤖 VS MCP Server

**Let AI assistants like Claude control Visual Studio through the Model Context Protocol!**

[![License](https://img.shields.io/github/license/CodingWithCalvin/VS-MCPServer?style=for-the-badge)](https://github.com/CodingWithCalvin/VS-MCPServer/blob/main/LICENSE)
[![Build Status](https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-MCPServer/build.yml?style=for-the-badge)](https://github.com/CodingWithCalvin/VS-MCPServer/actions/workflows/build.yml)
[![Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/CodingWithCalvin.VS-MCPServer?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-MCPServer)
[![Marketplace Installs](https://img.shields.io/visual-studio-marketplace/i/CodingWithCalvin.VS-MCPServer?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-MCPServer)
[![Marketplace Rating](https://img.shields.io/visual-studio-marketplace/r/CodingWithCalvin.VS-MCPServer?style=for-the-badge)](https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-MCPServer)
<p align="center">
<img src="https://raw.githubusercontent.com/CodingWithCalvin/VS-MCPServer/main/resources/logo.png" alt="VS MCP Server Logo" width="128" height="128">
</p>

<h1 align="center">VS MCP Server</h1>

<p align="center">
<strong>Let AI assistants like Claude control Visual Studio through the Model Context Protocol!</strong>
</p>

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

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

---

## 🤔 What is this?
## What is this?

**VS MCP Server** exposes Visual Studio features through the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/), enabling AI assistants like Claude to interact with your IDE programmatically. Open files, read code, build projects, and more - all through natural conversation!

## ✨ Features
## Features

### 📂 Solution Tools
### Solution Tools

| Tool | Description |
|------|-------------|
Expand All @@ -26,7 +50,7 @@
| `project_list` | List all projects in the solution |
| `project_info` | Get detailed project information |

### 📝 Document Tools
### Document Tools

| Tool | Description |
|------|-------------|
Expand All @@ -37,7 +61,7 @@
| `document_read` | Read document contents |
| `document_write` | Write to a document |

### ✏️ Editor Tools
### Editor Tools

| Tool | Description |
|------|-------------|
Expand All @@ -48,7 +72,7 @@
| `editor_goto_line` | Navigate to a specific line |
| `editor_find` | Search within documents |

### 🔨 Build Tools
### Build Tools

| Tool | Description |
|------|-------------|
Expand All @@ -58,7 +82,7 @@
| `build_cancel` | Cancel a running build |
| `build_status` | Get current build status |

## 🛠️ Installation
## Installation

### Visual Studio Marketplace

Expand All @@ -71,7 +95,7 @@

Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCalvin/VS-MCPServer/releases) page and double-click to install.

## 🚀 Usage
## Usage

### Starting the Server

Expand Down Expand Up @@ -106,7 +130,7 @@ Configure the extension at **Tools > Options > MCP Server**:
| Log Level | Minimum log level for output | `Information` |
| Log Retention | Days to keep log files | `7` |

## 🏗️ Architecture
## Architecture

```
+------------------+ +----------------------+ named pipes +------------------+
Expand All @@ -115,7 +139,7 @@ Configure the extension at **Tools > Options > MCP Server**:
+------------------+ :5050 +----------------------+ +------------------+
```

## 🤝 Contributing
## Contributing

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

Expand All @@ -127,18 +151,19 @@ Contributions are welcome! Whether it's bug reports, feature requests, or pull r
4. Ensure you have .NET 10.0 SDK installed
5. Press F5 to launch the experimental instance

## 📄 License
## License

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 -->

---

Made with ❤️ by [Coding With Calvin](https://github.com/CalvinAllen)
<p align="center">
Made with ❤️ by <a href="https://github.com/CodingWithCalvin">Coding With Calvin</a>
</p>