MCP淡水河谷服务器
使用Vale进行文本质量检查的模型上下文协议（MCP）服务器，允许通过AI进行样式和语法分析。
功能
- ✅ 使用 Vale 创建文本 lint 分析文本的质量和风格
- ✅ 检查山谷状态 - 确认Vale是否已安装和配置
- ✅ 多种验证样式 -谷歌、普罗斯林特、亚历克斯、WC风格
- ✅ 界面Web简单 - 用于测试的图形界面
- ✅ API HTTP 用于集成的 REST 端点
- ✅ 本机MCP协议 与AI助手直接集成
安装
- 克隆此仓库
- 安装依赖关系 ：
npm install
- 安装或验证（风格验证）：
- macOS brew install vale
- Ubuntu/Debian sudo apt install vale
- 或低于
- 编译工程 ：
npm run build
注意：要开发，请使用 npm run dev 操作观察。🚀 使用方法
这个项目提供 多种使用方式 以满足不同的需求：
🌟 单一命令 （更容易！）
# ⭐ RECOMENDADO: Inicia ambos servidores com um comando
`npm run start-npm`
# Alternativas (mesma funcionalidade):
`npm run start-js` # Versão Node.js
`./start-servers.sh` # Versão Bash (se disponível)🖥️ 传统Web界面 （两个命令）
- Terminal 1: Iniciar API HTTP
`npm run http`
- Terminal 2: Iniciar interface web
`npm run web`
- Acesse: `http://localhost:8080/web-interface.html` 🤖 MCP服务器 （适用于Claude台式机）
`npm start`📡 API HTTP Direta
- Testar via curl/API calls
curl -X POST http://localhost:3000/vale/lint \ -H "Content-Type: application/json" \ -d '{"text":"Your text here","fileName":"test.md"}'
🧩 使用 Gemini-CLI 运行 MCP
如果您使用称为“Gemini-CLI”（或类似）的客户端/CLI来管理MCP服务器和连接向导，以下是使用Gemini-CLI运行此服务器的实用指南。下面的说明是有意的，通用的 - 调整标志/名称/路径到您使用的Gemini-CLI的确切格式。
- 先决条件
- 已编译工程 （npm run build)您可以独立执行em modo(npm start). - 安装并配置 Vale（请参阅安装部分）。 - 在本地安装并配置 Gemini-CLI（请参阅您使用的 CLI 文档）。
- 在本地启动 MCP 服务器（ stdio / MCP 模式）
- Modo单机版（stdio MCP）： npm start
- 或者，如果您只想使用 MCP 服务器（编译文件）： node ./dist/index.js
- Gemini-CLI 配置示例
- 下面是一个指向此仓库 MCP 服务器的 JSON 配置文件的示例。根据您的环境调整路径。
{
"mcpServers": {
"vale-server": {
"command": "node",
"args": ["./dist/index.js"],
"env": {
"VALE_CONFIG_PATH": "./vale.ini"
},
"stdin": true,
"protocol": "mcp"
}
}
}- 注释 ： - args： 通往 dist/index.js 由 生成 npm run build. - VALE_CONFIG_PATH相对路径或绝对路径 vale.ini. - stdin/protocol示范字段 - 一些 CLI 使用不同的键来表示进程通过 stdio 或 socket 对 MCP 进行通信；检查您的Gemini-CLI的确切格式。
- 通过Gemini CLI访问Iniciando
- 保存上面的设置（例如 gemini-config.json一个典型的命令可能是：
gemini-cli --config ./gemini-config.json run vale-server
- 根据客户端，您可能有不同的子命令，例如 start, run, attach 或类似。请参阅您的 Gemini-CLI 文档以了解正确的语法。
- 常见流
- 流程A（进程管理CLI）：
- Gemini CLI信息 vale-server com stdio MCP。 - 向导/客户端通过MCP连接并使用工具（lint_text, vale_status等等）。
- 流 B （服务器已在运行） ：
- 您正在运行 npm start 分开。 - 配置Gemini-CLI以连接到进程 stdin/socket/port 支持。
- Dicas故障排除
- 如果 Gemini-CLI 无法连接： - 检查进程是否 node ./dist/index.js 它在旋转，没有错误。 - 确认 VALE_CONFIG_PATH 正确且 vale.ini 和 目录 styles/ 存在。 - 罗德 npm run build 如果文件在 dist/ 他们缺少。 - 如果 Valley 返回错误 ： - Vale可以返回退出代码 ！ = 0 当遇到 lint 问题时 — 这是预期的行为。使用工具 vale_status 哦 vale --version 验证安装。 - 日志： - 在 Gemini-CLI（如果可用）和 MCP 服务器上启用详细日志（例如：环境变量） DEBUG 或verbose flags）诊断MCP握手。
- 最小步骤示例
1. 构建： npm run build 1. 创建 gemini-config.json （调整路径） 1. 启动 Gemini-CLI： gemini-cli --config ./gemini-config.json run vale-server 1. 在客户端/向导中，选择服务器 vale-server 运行工具如 lint_text.
如果你告诉我你正在使用的Gemini-CLI的确切存储库/可执行文件（或粘贴预期的配置示例），我会根据你的CLI的确切格式调整配置片段和最终命令。
可用工具
lint_text
使用 Vale 样式检查器创建文本 。
参数 ：
text（string） 要分析的文本内容fileName（string， optional）： 文本的文件名 （默认 document.md）
check_vale_status
请检查 Vale 是否已安装并正常运行。
参数 ： 无
⚡ 快速命令
# 🚀 Iniciar tudo (RECOMENDADO)
`npm run start-npm`
# 🧪 Testar funcionalidade
`npm run test-server`
# 🔨 Compilar TypeScript
`npm run build`
# 🌐 Apenas interface web
`npm run web`
# 📡 Apenas API HTTP
`npm run http`💡 接口选择指南
✅ 对于初学者或快速测试：
- 界面Web:
http://localhost:8080/web-interface.html - 可视化，直观，无需配置
🤖 与 Claude Desktop 集成：
- MCP服务器在 claude_desktop_config.json 中设置
- 最适合常规使用与克劳德
🔧 与其他应用程序集成：
- API HTTP用于集成的 REST 端点
- 非常适合开发其他接口
项目结构
src/
├── index.ts # Servidor MCP principal
├── vale-service.ts # Serviço de integração com Vale
└── test.ts # Testes do servidor开发
- Modo de desenvolvimento (watch)
`npm run dev`
- Build
`npm run build`
- Testes
`npm test`环境变量
VALE_CONFIG_PATHvale.ini 文件路径（默认：./vale.ini）
常见问题
山谷未找到
- 确保 Vale 已安装：
- macOS brew install vale
- Ubuntu/Debian sudo apt install vale
- 视窗 choco install vale
- 或低于
配置问题
- 检查文件是否
vale.ini你在正确的位置 - 确保所需的样式在目录中
styles/
许可证
麻省理工学院