Skip to content

Commit 16818b2

Browse files
committed
docs(readme): format README to match template standards
- Add emoji prefix to tagline - Add emoji prefixes to all section headers - Add emoji prefixes to feature list items - Add emoji prefixes to commands, security, and requirements lists - Add 🎉 to installation and development setup completion steps
1 parent a09725c commit 16818b2

1 file changed

Lines changed: 31 additions & 31 deletions

File tree

README.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<h1 align="center">VSC as MCP</h1>
66

77
<p align="center">
8-
<strong>Supercharge your AI coding assistants with VS Code's powerful language intelligence!</strong>
8+
<strong>🚀 Supercharge your AI coding assistants with VS Code's powerful language intelligence!</strong>
99
</p>
1010

1111
<p align="center">
@@ -36,15 +36,15 @@
3636

3737
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!
3838

39-
## Features
39+
## Features
4040

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

47-
## Available Tools
47+
## 🛠️ Available Tools
4848

4949
| Tool | Description |
5050
|------|-------------|
@@ -68,14 +68,14 @@ A Visual Studio Code extension that exposes an MCP (Model Context Protocol) serv
6868
| `vscode_workspace_file_search` | Search for files by pattern |
6969
| `vscode_workspace_text_search` | Search for text across files |
7070

71-
## Installation
71+
## 📦 Installation
7272

7373
### VS Code Marketplace
7474

7575
1. Open VS Code
7676
2. Go to **Extensions** (Ctrl+Shift+X)
7777
3. Search for "VSC as MCP"
78-
4. Click **Install**
78+
4. Click **Install** 🎉
7979

8080
### Manual Installation
8181

@@ -85,11 +85,11 @@ Download the latest `.vsix` from the [Releases](https://github.com/CodingWithCal
8585
code --install-extension CodingWithCalvin.VSC-MCPServer.vsix
8686
```
8787

88-
## Usage
88+
## 🚀 Usage
8989

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

92-
### MCP Configuration
92+
### 🤖 MCP Configuration
9393

9494
Add to your MCP client configuration:
9595

@@ -104,7 +104,7 @@ Add to your MCP client configuration:
104104
}
105105
```
106106

107-
### URI Protocol
107+
### 🔗 URI Protocol
108108

109109
Launch VS Code and control the MCP server via URI:
110110

@@ -114,52 +114,52 @@ vscode://codingwithcalvin.mcp/start?port=4000 # Start on specific port
114114
vscode://codingwithcalvin.mcp/open?folder=/path/to/dir # Open folder and start
115115
```
116116

117-
## Configuration
117+
## ⚙️ Configuration
118118

119119
| Setting | Default | Description |
120120
|---------|---------|-------------|
121121
| `codingwithcalvin.mcp.autoStart` | `true` | Auto-start server on VS Code launch |
122122
| `codingwithcalvin.mcp.port` | `4000` | MCP server port |
123123
| `codingwithcalvin.mcp.bindAddress` | `127.0.0.1` | Bind address (localhost only) |
124124

125-
## Commands
125+
## 💻 Commands
126126

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

129-
- **MCP Server: Start** - Start the MCP server
130-
- **MCP Server: Stop** - Stop the MCP server
131-
- **MCP Server: Restart** - Restart the MCP server
132-
- **MCP Server: Show Available Tools** - View all available MCP tools
129+
- ▶️ **MCP Server: Start** - Start the MCP server
130+
- ⏹️ **MCP Server: Stop** - Stop the MCP server
131+
- 🔄 **MCP Server: Restart** - Restart the MCP server
132+
- 📋 **MCP Server: Show Available Tools** - View all available MCP tools
133133

134-
## Security
134+
## 🔒 Security
135135

136-
- **Localhost Only** - Binds only to `127.0.0.1`
137-
- **DNS Rebinding Protection** - Validates Host header
138-
- **Same-machine Trusted** - No authentication required for local access
136+
- 🏠 **Localhost Only** - Binds only to `127.0.0.1`
137+
- 🛡️ **DNS Rebinding Protection** - Validates Host header
138+
- **Same-machine Trusted** - No authentication required for local access
139139

140-
## Requirements
140+
## 📋 Requirements
141141

142-
- Visual Studio Code 1.85.0 or later
143-
- Node.js (bundled with VS Code)
142+
- 💻 Visual Studio Code 1.85.0 or later
143+
- 🟢 Node.js (bundled with VS Code)
144144

145-
## Contributing
145+
## 🤝 Contributing
146146

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

149-
### Development Setup
149+
### 🔧 Development Setup
150150

151151
1. Clone the repository
152152
2. Run `npm install`
153153
3. Run `npm run build`
154-
4. Press F5 to launch the Extension Development Host
154+
4. Press F5 to launch the Extension Development Host 🎉
155155

156-
## License
156+
## 📄 License
157157

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

160160
---
161161

162-
## Contributors
162+
## 👥 Contributors
163163

164164
<!-- readme: contributors -start -->
165165
<!-- readme: contributors -end -->

0 commit comments

Comments
 (0)