Skip to content

Commit 0a3d56a

Browse files
authored
docs(readme): standardize format to match template (#28)
- Centered header with logo, title, and tagline - Two rows of badges (License/Build, then Marketplace) - Consistent section structure with horizontal rules - Contributors section with markers - Centered footer with attribution
1 parent cecad12 commit 0a3d56a

1 file changed

Lines changed: 48 additions & 23 deletions

File tree

README.md

Lines changed: 48 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,46 @@
1-
# 🤖 VS MCP Server
2-
3-
**Let AI assistants like Claude control Visual Studio through the Model Context Protocol!**
4-
5-
[![License](https://img.shields.io/github/license/CodingWithCalvin/VS-MCPServer?style=for-the-badge)](https://github.com/CodingWithCalvin/VS-MCPServer/blob/main/LICENSE)
6-
[![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)
7-
[![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)
8-
[![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)
9-
[![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)
1+
<p align="center">
2+
<img src="https://raw.githubusercontent.com/CodingWithCalvin/VS-MCPServer/main/resources/logo.png" alt="VS MCP Server Logo" width="128" height="128">
3+
</p>
4+
5+
<h1 align="center">VS MCP Server</h1>
6+
7+
<p align="center">
8+
<strong>Let AI assistants like Claude control Visual Studio through the Model Context Protocol!</strong>
9+
</p>
10+
11+
<p align="center">
12+
<a href="https://github.com/CodingWithCalvin/VS-MCPServer/blob/main/LICENSE">
13+
<img src="https://img.shields.io/github/license/CodingWithCalvin/VS-MCPServer?style=for-the-badge" alt="License">
14+
</a>
15+
<a href="https://github.com/CodingWithCalvin/VS-MCPServer/actions/workflows/build.yml">
16+
<img src="https://img.shields.io/github/actions/workflow/status/CodingWithCalvin/VS-MCPServer/build.yml?style=for-the-badge" alt="Build Status">
17+
</a>
18+
</p>
19+
20+
<p align="center">
21+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-MCPServer">
22+
<img src="https://img.shields.io/visual-studio-marketplace/v/CodingWithCalvin.VS-MCPServer?style=for-the-badge" alt="Marketplace Version">
23+
</a>
24+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-MCPServer">
25+
<img src="https://img.shields.io/visual-studio-marketplace/i/CodingWithCalvin.VS-MCPServer?style=for-the-badge" alt="Marketplace Installations">
26+
</a>
27+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-MCPServer">
28+
<img src="https://img.shields.io/visual-studio-marketplace/d/CodingWithCalvin.VS-MCPServer?style=for-the-badge" alt="Marketplace Downloads">
29+
</a>
30+
<a href="https://marketplace.visualstudio.com/items?itemName=CodingWithCalvin.VS-MCPServer">
31+
<img src="https://img.shields.io/visual-studio-marketplace/r/CodingWithCalvin.VS-MCPServer?style=for-the-badge" alt="Marketplace Rating">
32+
</a>
33+
</p>
1034

1135
---
1236

13-
## 🤔 What is this?
37+
## What is this?
1438

1539
**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!
1640

17-
## Features
41+
## Features
1842

19-
### 📂 Solution Tools
43+
### Solution Tools
2044

2145
| Tool | Description |
2246
|------|-------------|
@@ -26,7 +50,7 @@
2650
| `project_list` | List all projects in the solution |
2751
| `project_info` | Get detailed project information |
2852

29-
### 📝 Document Tools
53+
### Document Tools
3054

3155
| Tool | Description |
3256
|------|-------------|
@@ -37,7 +61,7 @@
3761
| `document_read` | Read document contents |
3862
| `document_write` | Write to a document |
3963

40-
### ✏️ Editor Tools
64+
### Editor Tools
4165

4266
| Tool | Description |
4367
|------|-------------|
@@ -48,7 +72,7 @@
4872
| `editor_goto_line` | Navigate to a specific line |
4973
| `editor_find` | Search within documents |
5074

51-
### 🔨 Build Tools
75+
### Build Tools
5276

5377
| Tool | Description |
5478
|------|-------------|
@@ -58,7 +82,7 @@
5882
| `build_cancel` | Cancel a running build |
5983
| `build_status` | Get current build status |
6084

61-
## 🛠️ Installation
85+
## Installation
6286

6387
### Visual Studio Marketplace
6488

@@ -71,7 +95,7 @@
7195

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

74-
## 🚀 Usage
98+
## Usage
7599

76100
### Starting the Server
77101

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

109-
## 🏗️ Architecture
133+
## Architecture
110134

111135
```
112136
+------------------+ +----------------------+ named pipes +------------------+
@@ -115,7 +139,7 @@ Configure the extension at **Tools > Options > MCP Server**:
115139
+------------------+ :5050 +----------------------+ +------------------+
116140
```
117141

118-
## 🤝 Contributing
142+
## Contributing
119143

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

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

130-
## 📄 License
154+
## License
131155

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

134158
---
135159

136-
## 👥 Contributors
160+
## Contributors
137161

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

142165
---
143166

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

0 commit comments

Comments
 (0)