|
1 | 1 | # Excel MCP Server - Agent Skills |
2 | 2 |
|
3 | | -Cross-platform AI assistant guidance for Excel MCP Server, following the emerging Agent Skills specification. |
4 | | - |
5 | | -## Two Skills for Different Use Cases |
| 3 | +Two skill packages for AI coding assistants: |
6 | 4 |
|
7 | 5 | | Skill | Target | Best For | |
8 | 6 | |-------|--------|----------| |
9 | | -| **[excel-cli](excel-cli/SKILL.md)** | CLI Tool | **Coding agents** (Copilot, Cursor, Windsurf) - token-efficient, `--help` discoverable | |
10 | | -| **[excel-mcp](excel-mcp/SKILL.md)** | MCP Server | **Conversational AI** (Claude Desktop, VS Code Chat) - rich tool schemas, exploratory workflows | |
11 | | - |
12 | | -### When to use CLI (Recommended for Coding Agents) |
13 | | - |
14 | | -Modern coding agents increasingly favor CLI-based workflows over MCP because: |
15 | | -- **Token-efficient**: No large tool schemas loaded into context |
16 | | -- **Discoverable**: Agents can run `excelcli --help` to learn commands |
17 | | -- **Scriptable**: Works in PowerShell pipelines, CI/CD, batch processing |
18 | | -- **Quiet mode**: `-q` flag outputs clean JSON only |
19 | | - |
20 | | -```powershell |
21 | | -# Coding agent workflow |
22 | | -excelcli -q session open C:\Data\Report.xlsx |
23 | | -excelcli -q range set-values --session 1 --sheet Sheet1 --range A1 --values-json '[["Hello"]]' |
24 | | -excelcli -q session close --session 1 --save |
25 | | -``` |
26 | | - |
27 | | -### When to use MCP Server |
28 | | - |
29 | | -MCP remains relevant for: |
30 | | -- Exploratory automation with iterative reasoning |
31 | | -- Self-healing workflows needing rich introspection |
32 | | -- Long-running autonomous tasks with continuous context |
33 | | -- Conversational interfaces (Claude Desktop, VS Code Chat) |
| 7 | +| **[excel-cli](excel-cli/SKILL.md)** | CLI Tool | Coding agents - token-efficient, `--help` discoverable | |
| 8 | +| **[excel-mcp](excel-mcp/SKILL.md)** | MCP Server | Conversational AI - rich tool schemas | |
34 | 9 |
|
35 | | -## What Are Agent Skills? |
36 | | - |
37 | | -Agent Skills are reusable instruction sets that extend AI coding assistants with domain-specific knowledge. They enable consistent, reliable behavior when working with specific tools like Excel MCP Server. |
38 | | - |
39 | | -## Supported Platforms |
40 | | - |
41 | | -| Platform | Install Location | Auto-Install | |
42 | | -|----------|------------------|--------------| |
43 | | -| **GitHub Copilot** | `~/.copilot/skills/excel-mcp/` | Via VS Code extension | |
44 | | -| **Claude Code** | `.claude/skills/excel-mcp/` | Manual or npx | |
45 | | -| **Cursor** | `.cursor/skills/excel-mcp/` | Manual or npx | |
46 | | -| **Windsurf** | `.windsurf/skills/excel-mcp/` | Manual or npx | |
47 | | -| **Gemini CLI** | `.gemini/skills/excel-mcp/` | Manual or npx | |
48 | | -| **Goose** | `.goose/skills/excel-mcp/` | Manual or npx | |
49 | | - |
50 | | -## Installation Methods |
51 | | - |
52 | | -### Method 1: VS Code Extension (Copilot) |
53 | | - |
54 | | -Install the [Excel MCP Server extension](https://marketplace.visualstudio.com/items?itemName=sbroenne.excel-mcp) - skills are installed automatically to `~/.copilot/skills/`. |
55 | | - |
56 | | -Enable skills in VS Code settings: |
57 | | -```json |
58 | | -{ |
59 | | - "chat.useAgentSkills": true |
60 | | -} |
61 | | -``` |
62 | | - |
63 | | -### Method 2: npx skills add (Cross-Platform) |
64 | | - |
65 | | -The repository contains TWO skills. The CLI will prompt you to select which one(s) to install: |
| 10 | +## Installation |
66 | 11 |
|
67 | 12 | ```bash |
68 | | -# Interactive install - prompts to select excel-cli, excel-mcp, or both |
69 | | -npx skills add sbroenne/mcp-server-excel |
70 | | - |
71 | | -# Install specific skill directly |
| 13 | +# Via VS Code extension (auto-installs excel-mcp) |
| 14 | +# Or via npx: |
72 | 15 | npx skills add sbroenne/mcp-server-excel --skill excel-cli # Coding agents |
73 | 16 | npx skills add sbroenne/mcp-server-excel --skill excel-mcp # Conversational AI |
74 | | - |
75 | | -# Install both skills |
76 | | -npx skills add sbroenne/mcp-server-excel --skill '*' |
77 | | - |
78 | | -# Install for specific agent |
79 | | -npx skills add sbroenne/mcp-server-excel --skill excel-cli -a cursor |
80 | | -npx skills add sbroenne/mcp-server-excel --skill excel-mcp -a claude-code |
81 | | - |
82 | | -# Install globally (user-wide) |
83 | | -npx skills add sbroenne/mcp-server-excel --skill excel-cli --global |
84 | 17 | ``` |
85 | 18 |
|
86 | | -### Method 3: GitHub Release Download |
87 | | - |
88 | | -Download `excel-skills-vX.X.X.zip` from [GitHub Releases](https://github.com/sbroenne/mcp-server-excel/releases/latest). |
89 | | - |
90 | | -The package contains both skills: |
91 | | -- `skills/excel-cli/` - for coding agents (Copilot, Cursor, Windsurf) |
92 | | -- `skills/excel-mcp/` - for conversational AI (Claude Desktop, VS Code Chat) |
93 | | - |
94 | | -Extract the skill(s) you need to your AI assistant's skills directory: |
95 | | -- Copilot: `~/.copilot/skills/excel-cli/` or `~/.copilot/skills/excel-mcp/` |
96 | | -- Claude Code: `.claude/skills/excel-cli/` or `.claude/skills/excel-mcp/` |
97 | | -- Cursor: `.cursor/skills/excel-mcp/` or `.cursor/skills/excel-cli/` |
98 | | -- Windsurf: `.windsurf/skills/excel-mcp/` or `.windsurf/skills/excel-cli/` |
99 | | - |
100 | | -### Method 4: Git Clone (Development) |
101 | | - |
102 | | -```bash |
103 | | -# Clone and copy |
104 | | -git clone https://github.com/sbroenne/mcp-server-excel.git |
105 | | -cp -r mcp-server-excel/skills/excel-mcp ~/.copilot/skills/ |
106 | | -``` |
107 | | - |
108 | | -## Directory Structure |
109 | | - |
110 | | -``` |
111 | | -skills/ |
112 | | -├── README.md # This file |
113 | | -├── shared/ # Shared behavioral guidance (source of truth) |
114 | | -│ ├── behavioral-rules.md # Core execution rules |
115 | | -│ ├── anti-patterns.md # Common mistakes to avoid |
116 | | -│ ├── workflows.md # Production workflow patterns |
117 | | -│ ├── powerquery.md # Power Query specifics |
118 | | -│ ├── datamodel.md # Data Model/DAX specifics |
119 | | -│ ├── table.md # Table operations |
120 | | -│ ├── range.md # Range operations |
121 | | -│ ├── worksheet.md # Worksheet operations |
122 | | -│ ├── chart.md # Chart operations |
123 | | -│ ├── slicer.md # Slicer operations |
124 | | -│ └── conditionalformat.md # Conditional formatting |
125 | | -├── excel-mcp/ # MCP Server skill package |
126 | | -│ ├── SKILL.md # Primary skill definition (MCP tools) |
127 | | -│ ├── README.md # MCP skill installation guide |
128 | | -│ ├── VERSION # Version tracking |
129 | | -│ └── references/ # MCP-specific + shared (copied during build) |
130 | | -│ ├── claude-desktop.md # Claude Desktop setup (MCP-specific) |
131 | | -│ └── (shared files) # Copied from shared/ by build script |
132 | | -├── excel-cli/ # CLI skill package |
133 | | -│ ├── SKILL.md # CLI commands documentation |
134 | | -│ ├── README.md # CLI skill installation guide |
135 | | -│ └── references/ # CLI-specific + shared (copied during build) |
136 | | -│ ├── README.md # Explains build process |
137 | | -│ └── (shared files) # Copied from shared/ by build script |
138 | | -├── CLAUDE.md # Claude Code project instructions |
139 | | -└── .cursorrules # Cursor-specific rules |
140 | | -``` |
141 | | - |
142 | | -**Note:** Shared behavioral guidance lives in `shared/` and is copied to each skill's `references/` folder during the build. Run `dotnet build -c Release` to generate SKILL.md and copy references. |
143 | | - |
144 | | -## Platform-Specific Files |
145 | | - |
146 | | -### For Claude Code Users |
147 | | - |
148 | | -Copy `CLAUDE.md` to your project root: |
149 | | -```bash |
150 | | -cp skills/CLAUDE.md /path/to/your/project/CLAUDE.md |
151 | | -``` |
152 | | - |
153 | | -Or reference from `.claude/skills/`: |
154 | | -```bash |
155 | | -mkdir -p .claude/skills |
156 | | -cp -r skills/excel-mcp .claude/skills/ |
157 | | -``` |
158 | | - |
159 | | -### For Cursor Users |
160 | | - |
161 | | -Copy `.cursorrules` to your project root: |
162 | | -```bash |
163 | | -cp skills/.cursorrules /path/to/your/project/.cursorrules |
164 | | -``` |
165 | | - |
166 | | -## Building the Skills Package |
167 | | - |
168 | | -Skill files are generated automatically during Release builds: |
| 19 | +## Building |
169 | 20 |
|
170 | 21 | ```powershell |
171 | | -# Build solution - generates SKILL.md and copies references |
172 | 22 | dotnet build -c Release |
173 | | -
|
174 | | -# Output (in skills/ folder): |
175 | | -# excel-mcp/SKILL.md - Generated MCP skill documentation |
176 | | -# excel-mcp/references/ - Copied shared reference files |
177 | | -# excel-cli/SKILL.md - Generated CLI skill documentation |
178 | | -# excel-cli/references/ - Copied shared reference files |
179 | 23 | ``` |
180 | 24 |
|
181 | | -For release artifacts (ZIP package), the GitHub Actions workflow handles packaging. |
| 25 | +Generates `SKILL.md` and copies `shared/` references into each skill's `references/` folder. |
182 | 26 |
|
183 | | -## Version Compatibility |
| 27 | +## Structure |
184 | 28 |
|
185 | | -| Skills Version | MCP Server Version | Minimum Excel | |
186 | | -|----------------|-------------------|---------------| |
187 | | -| 1.2.0+ | 1.2.0+ | Excel 2016+ | |
188 | | -| 1.1.x | 1.1.x | Excel 2016+ | |
189 | | - |
190 | | -## Contributing |
191 | | - |
192 | | -See [CONTRIBUTING.md](../docs/CONTRIBUTING.md) for guidelines on improving the skills. |
193 | | - |
194 | | -## Related Resources |
195 | | - |
196 | | -- [Excel MCP Server Documentation](https://excelmcpserver.dev/) |
197 | | -- [MCP Registry](https://mcp.run/registry) |
198 | | -- [agentskills.io Specification](https://agentskills.io) |
| 29 | +``` |
| 30 | +skills/ |
| 31 | +├── shared/ # Shared behavioral guidance (source of truth) |
| 32 | +├── excel-mcp/ # MCP Server skill (SKILL.md + references/) |
| 33 | +├── excel-cli/ # CLI skill (SKILL.md + references/) |
| 34 | +├── templates/ # Scriban templates for SKILL.md generation |
| 35 | +├── CLAUDE.md # Claude Code project instructions |
| 36 | +└── .cursorrules # Cursor-specific rules |
| 37 | +``` |
0 commit comments