grammar-police-mcp 1.0.0

package/.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish to NPM
+
+# 触发条件：当你创建并发布一个新的 Release 时触发
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      # 1. 拉取代码
+      - uses: actions/checkout@v4
+
+      # 2. 设置 Node.js 环境
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "18"
+          # 这里告诉 GitHub 我们要连接的是 npm 官方源
+          registry-url: "https://registry.npmjs.org"
+
+      # 3. 安装依赖 (npm ci 比 npm install 更适合自动化环境)
+      - run: npm ci
+
+      # 4. 构建 TypeScript (确保你有 build 脚本)
+      - run: npm run build
+
+      # 5. 发布到 NPM
+      - run: npm publish
+        env:
+          # 这里会自动读取你在第二步设置的 Secret
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 franz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,115 @@
+# Grammar Police MCP Server
+
+An MCP (Model Context Protocol) server that provides grammar checking capabilities to MCP-compatible clients like Claude Code.
+
+## How It Works
+
+This server exposes a `check_grammar` tool that accepts text input. The tool returns the text to the client along with instructions (in the tool description) for how to analyze and correct grammar errors.
+
+The actual grammar checking is performed by the LLM client (e.g., Claude Code), not the server itself. This design keeps the server lightweight while leveraging the LLM's language understanding capabilities.
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org/) (v18 or higher)
+- npm (comes with Node.js)
+- [Claude Code](https://claude.ai/download) CLI tool
+
+## Installation
+
+### Option 1: Clone from GitHub
+
+```bash
+# Clone the repository
+git clone https://github.com/YOUR_USERNAME/grammar-police-mcp.git
+cd grammar-police-mcp
+
+# Install dependencies
+npm install
+
+# Build the project
+npm run build
+```
+
+### Option 2: Download Release
+
+1. Download the latest release from the [Releases](https://github.com/YOUR_USERNAME/grammar-police-mcp/releases) page
+2. Extract the archive
+3. Run `npm install && npm run build`
+
+## Configuration
+
+### Claude Code Setup
+
+1. Open your Claude Code MCP settings file:
+   - **Windows:** `%USERPROFILE%\.claude\claude_desktop_config.json`
+   - **macOS/Linux:** `~/.claude/claude_desktop_config.json`
+
+2. Add the grammar-police server to the `mcpServers` section:
+
+```json
+{
+  "mcpServers": {
+    "grammar-police": {
+      "command": "node",
+      "args": ["C:/path/to/grammar-police-mcp/dist/index.js"]
+    }
+  }
+}
+```
+
+> **Note:** Replace `C:/path/to/grammar-police-mcp` with the actual path where you cloned/extracted the project.
+
+3. Restart Claude Code to load the new MCP server
+
+### Verify Installation
+
+After restarting Claude Code, run `/mcp` to check if the grammar-police server is connected.
+
+## Usage
+
+Once configured, Claude Code will automatically have access to the `check_grammar` tool. You can instruct Claude to check grammar by configuring your `CLAUDE.md` file to call the tool on user input.
+
+### Example CLAUDE.md Configuration
+
+```markdown
+You have access to a tool named `grammar-police`. Call the `check_grammar` tool with user input to check for grammar errors before responding.
+```
+
+### Running Standalone (Development)
+
+```bash
+npm start
+```
+
+## Tool: check_grammar
+
+**Input:**
+- `text` (string): The text to check for grammar errors
+
+**Output:**
+- The input text, returned to the client for grammar analysis
+
+**Expected Client Response Format:**
+```
+"original" -> "corrected"
+Corrected: "full corrected sentence"
+```
+
+Or if no errors: `No grammar issues.`
+
+**Ignored:** Capitalization, punctuation, technical terms/variable names, error/warning logs.
+
+## Scripts
+
+- `npm run build` - Compile TypeScript to JavaScript
+- `npm start` - Run the compiled server
+- `npm run dev` - Watch mode for development
+
+## Dependencies
+
+- `@modelcontextprotocol/sdk` - MCP server SDK
+- `zod` - Schema validation
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { z } from "zod";
+const server = new McpServer({
+    name: "grammar-police",
+    version: "1.0.0",
+});
+const TOOL_DESCRIPTION = `Check and correct English grammar in the provided text. Returns corrections in a structured format.
+
+When you receive the text, analyze it for grammar errors and respond with:
+- "original" -> "corrected" for each error found
+- Corrected: "full corrected sentence"
+- If no errors: "No grammar issues."
+
+IGNORE: Capitalization, punctuation, technical terms/variable names, error/warning logs.`;
+server.tool("check_grammar", TOOL_DESCRIPTION, {
+    text: z.string().describe("The text to check for grammar errors"),
+}, async ({ text }) => ({
+    content: [{ type: "text", text }],
+}));
+async function main() {
+    const transport = new StdioServerTransport();
+    await server.connect(transport);
+    console.error("Grammar Police MCP server running on stdio");
+}
+main().catch(console.error);

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "grammar-police-mcp",
+  "version": "1.0.0",
+  "description": "MCP server that corrects English grammar",
+  "type": "module",
+  "main": "dist/index.js",
+  "bin": {
+    "grammar-police-mcp": "dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "dev": "tsc --watch"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.0.0",
+    "zod": "^3.22.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "typescript": "^5.3.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { z } from "zod";
+
+const server = new McpServer({
+  name: "grammar-police",
+  version: "1.0.0",
+});
+
+const TOOL_DESCRIPTION = `Check and correct English grammar in the provided text. Returns corrections in a structured format.
+
+When you receive the text, analyze it for grammar errors and respond with:
+- "original" -> "corrected" for each error found
+- Corrected: "full corrected sentence"
+- If no errors: "No grammar issues."
+
+IGNORE: Capitalization, punctuation, technical terms/variable names, error/warning logs.`;
+
+server.tool(
+  "check_grammar",
+  TOOL_DESCRIPTION,
+  {
+    text: z.string().describe("The text to check for grammar errors"),
+  },
+  async ({ text }) => ({
+    content: [{ type: "text", text }],
+  })
+);
+
+async function main() {
+  const transport = new StdioServerTransport();
+  await server.connect(transport);
+  console.error("Grammar Police MCP server running on stdio");
+}
+
+main().catch(console.error);

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "declaration": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}