You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+12-10Lines changed: 12 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,10 @@ A [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that i
6
6
7
7
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.
8
8
9
+
## Quick install
10
+
11
+
[<imgsrc="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)[<imgalt="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)[<imgsrc="https://cursor.com/deeplink/mcp-install-dark.svg"alt="Install in Cursor">](https://cursor.com/install-mcp?name=Vale&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyJ2YWxlLW1jcEBsYXRlc3QiXX0=)
12
+
9
13
## Features
10
14
11
15
- ✅ File linting: Check any text file for style issues with Vale
@@ -34,14 +38,8 @@ npm install
34
38
35
39
# Build the TypeScript project
36
40
npm run build
37
-
```
38
-
39
-
### Install globally (recommended for most users)
40
41
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)
45
43
npm run install:global
46
44
```
47
45
@@ -95,7 +93,9 @@ Restart Claude Desktop after updating the configuration.
95
93
96
94
### VS Code (GitHub Copilot)
97
95
98
-
You can add the Vale MCP server to VS Code in two ways:
96
+
[<imgsrc="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)[<imgalt="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:
99
99
100
100
#### Option A: Command Palette (easiest)
101
101
@@ -161,7 +161,9 @@ Add to your VS Code settings file:
161
161
162
162
### Cursor
163
163
164
-
Add to your Cursor MCP settings (follow [Cursor's MCP documentation](https://docs.cursor.com/advanced/model-context-protocol)):
164
+
[<imgsrc="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)):
165
167
166
168
**Using global install:**
167
169
@@ -408,4 +410,4 @@ Created by @chrischinchilla and @theletterf
408
410
409
411
## License
410
412
411
-
MIT License - see LICENSE file for details.
413
+
MIT License. Refer to the LICENSE file for details.
0 commit comments