wps-mcp

WPS Skills > Any functional or architectural updates to this project must be synchronized with relevant documentation updates after completion. This is part of our commitment. AI programming assistant controls WPS Office's MCP toolset through natural language. ## Project Positioning This project is an MCP Server + Skills framework that enables AI assistants (Claude Code/Cursor/Augment, etc.) to control WPS Office. - 231 MCP professional tools + 12 built-in tools = 243 tools - Supports Excel (82 tools) / Word (28 tools) / PPT (112 tools) / General (9 tools) - Supports macOS, Windows, Linux ## Prerequisites - WPS Office installed (https://www.wps.cn/ or https://www.wps.com/) - Node.js >= 18.0.0 - Git ## Automatic by AI) The following steps are automatically executed by the AI assistant. Steps requiring human interaction are marked with ⚠️. ### Step 1: Clone the Project ```git clone https://github.com/lc2panda/wps-skills.git cd wps-skills ``` If the project already exists, skip this step. ### Step 2: Install Dependencies and Compile ```bash cd wps-office-mcp npm install npm run build cd .. ``` ### Step 3: Configure MCP Server Write the following configuration to the corresponding file based on the AI tool used. Make sure to replace the path with the actual absolute project path. **Claude Code** — Write to `~/.claude/settings.json`: ```json { "mcpServers": { "wps-office": { "command": "node", "args"/your/path/wps-skills/w-mcp/dist/index.js"] } } } ``` **Cursor** — Write to the project root directory `.cursor/mcp.json`: ```json { "mcpServers": { "wps-office": { "command": "node", "args": ["/your/path/wps-skills/wps-office/dist/index.js"] } } } ``` **OpenAI Codex CLI** — Write to `~/.codex/config.toml```toml [mcp_servers.wpscommand = "node" args = ["//wps-skps-office-mcp/dist/index.js"] ``` or register via command line: `codex mcp add wps-office -- node /your/path/wps-skills/wps-office-mcp/dist/index.js` **Augment / Other MCP Compatible IDEs** — Refer to the MCP Server configuration documentation for each IDE, using the same command and This project's MCP Server is a standard std (spec 2025-11-25 with all MCP first-class clients (Claude Code / Cursor / Codex CLI / GitHub Copilot CLI / Windsurf, etc.). ### Step 4: Install WPS Add-in ⚠️ Requires human operation (AI cannot directly operate the WPS application): ```bash # macOS bash-install-mac.sh # Windows (Powerpowershell scripts/install.ps1 # Linux bash scripts/install.sh ``` add-in must be restarted after installation for take effect. ### Step 5: Install Skills (Only for Claude Code) ```bash # Create skills directory (if it doesn't exist) mkdir -p ~/.claude/skills # Create symbolic links ln -sf "$(pwd)/skills/wps-excel" ~/.claude/skills/wps-excel ln -sf "$(pwd/wps-wordclaude/skps-word ln -sf "$(pwd)/skills/wps-ppt" ~/.claude/wps-pln -sf "$(pwd)/skills/wps-office" ~/.claude/skills/wps-office ``` ### Step 6: Verify Installation ```bash # Verify MCP Server can be started node wps-office-mcp.js & # Should see "MCP Server started successfully" log kill %1 2>/dev/null ``` ## Architecture ``` Skills layer (SKILL.md natural language guidance) ↓ Claude Code calls MCP Server layer (239 tools) ↓ wpsClient.executeMethod() Execution layer ├── macOS: wps-claude-assistant (227 action, HTTP polling) └── Windows: wps-com.ps1 (231 action, COM interface) ``` ## Tool List | Application of Tools | Main Capabilities | |-------------|-----------------|------------------| | Excel | 82 /data/charts/pivot tables/worksheet/format/row/column/comment protection/image export | | Word | 28 | Format/content/document management/header/footer/comment/template filling/paragraph structure | | PPT | | Slides/shape/image/table/beautification/animation/chart/3D/data visualization/image export | | General | 9 | Save/connection detection/text selection/format conversion | | Built-in | 12 | Connection check/universal method call/data cache | ## Troubleshooting | Issue | Solution | |-------|----------| | MCP connection failed | Confirm `npm install && npm run been executed, check if dist/index.js exists | | WPS unresponsive | Restart WPS Office, confirm add-in is installed | | "arguments error" | Re-run installation script, restart WPS | | Linux plugin not found | Refer