Skip to content

Commit ed3afc9

Browse files
Merge pull request #15 from ChrisChinchilla/refactor-install-instructions
Refactor install instructions
2 parents bb12dfd + fcfb5fb commit ed3afc9

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

readme.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ A [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that i
66

77
This MCP server provides AI assistants with the ability to check files for style and grammar issues using Vale's powerful linting engine. It automatically discovers Vale configuration files and provides formatted, actionable feedback about writing quality.
88

9+
## Quick install
10+
11+
[<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522vale%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522vale-mcp%2540latest%2522%255D%257D) [<img alt="Install in VS Code Insiders" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Server&color=24bfa5">](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522vale%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522vale-mcp%2540latest%2522%255D%257D) [<img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Install in Cursor">](https://cursor.com/install-mcp?name=Vale&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyJ2YWxlLW1jcEBsYXRlc3QiXX0=)
12+
913
## Features
1014

1115
- ✅ File linting: Check any text file for style issues with Vale
@@ -34,14 +38,8 @@ npm install
3438

3539
# Build the TypeScript project
3640
npm run build
37-
```
38-
39-
### Install globally (recommended for most users)
4041

41-
Installing globally creates a `vale-cli` command available system-wide:
42-
43-
```bash
44-
# From the Vale-MCP directory
42+
# Install globally (creates a system-wide vale-cli command)
4543
npm run install:global
4644
```
4745

@@ -95,7 +93,9 @@ Restart Claude Desktop after updating the configuration.
9593

9694
### VS Code (GitHub Copilot)
9795

98-
You can add the Vale MCP server to VS Code in two ways:
96+
[<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code">](https://insiders.vscode.dev/redirect?url=vscode%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522vale%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522vale-mcp%2540latest%2522%255D%257D) [<img alt="Install in VS Code Insiders" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Server&color=24bfa5">](https://insiders.vscode.dev/redirect?url=vscode-insiders%3Amcp%2Finstall%3F%257B%2522name%2522%253A%2522vale%2522%252C%2522command%2522%253A%2522npx%2522%252C%2522args%2522%253A%255B%2522vale-mcp%2540latest%2522%255D%257D)
97+
98+
You can also add the Vale MCP server to VS Code manually:
9999

100100
#### Option A: Command Palette (easiest)
101101

@@ -161,7 +161,9 @@ Add to your VS Code settings file:
161161

162162
### Cursor
163163

164-
Add to your Cursor MCP settings (follow [Cursor's MCP documentation](https://docs.cursor.com/advanced/model-context-protocol)):
164+
[<img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Install in Cursor">](https://cursor.com/install-mcp?name=Vale&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyJ2YWxlLW1jcEBsYXRlc3QiXX0=)
165+
166+
You can also add the Vale MCP server manually (follow [Cursor's MCP documentation](https://docs.cursor.com/advanced/model-context-protocol)):
165167

166168
**Using global install:**
167169

@@ -408,4 +410,4 @@ Created by @chrischinchilla and @theletterf
408410

409411
## License
410412

411-
MIT License - see LICENSE file for details.
413+
MIT License. Refer to the LICENSE file for details.

0 commit comments

Comments
 (0)