|
1 | 1 | # Effect Patterns MCP Server — End User Guide |
2 | 2 |
|
3 | | -Use the **Effect Patterns MCP server** from your IDE (Cursor, Claude Code, Windsurf, or any MCP client) to search 700+ Effect-TS patterns and browse the rule catalog. The MCP server is a **patterns + rule catalog** tool only; it does not analyze, review, or refactor your code. |
| 3 | +Use the **Effect Patterns MCP server** from your IDE (Cursor, Claude Code, Windsurf, or any MCP client) to search 700+ Effect-TS patterns, browse curated skills, and inspect the rule catalog. The MCP server is a **patterns + skills + rule catalog** tool only; it does not analyze, review, or refactor your code. |
4 | 4 |
|
5 | 5 | --- |
6 | 6 |
|
7 | 7 | ## What You Get |
8 | 8 |
|
9 | 9 | - **Pattern search** — Find patterns by keyword, category, or difficulty (beginner / intermediate / advanced). |
10 | 10 | - **Pattern details** — Full docs and code examples for any pattern by ID. |
| 11 | +- **Skills catalog** — Search and retrieve curated Effect-TS skills by query/category. |
11 | 12 | - **Rule catalog** (read-only) — List all analysis rule metadata (IDs, severity, categories). No code scanning. |
12 | 13 |
|
13 | 14 | Code analysis, review, refactoring, and pattern code generation are **not** available via MCP; they are offered through the [HTTP API](#http-api) and paid CLI only. |
@@ -129,7 +130,7 @@ Never commit API keys; use environment variables or your IDE's secret storage. |
129 | 130 |
|
130 | 131 | ## MCP Tools (Free Tier) |
131 | 132 |
|
132 | | -The MCP server exposes **exactly three tools** in production and staging. No other tools (including code analysis or review) are available via MCP. |
| 133 | +The MCP server exposes **exactly five tools** in production and staging. No other tools (including code analysis or review) are available via MCP. |
133 | 134 |
|
134 | 135 | ### 1. `search_patterns` |
135 | 136 |
|
@@ -181,6 +182,38 @@ No parameters. |
181 | 182 |
|
182 | 183 | --- |
183 | 184 |
|
| 185 | +### 4. `list_skills` |
| 186 | + |
| 187 | +Search skills by query and optional category filters. |
| 188 | + |
| 189 | +| Parameter | Type | Required | Description | |
| 190 | +|-----------|------|----------|-------------| |
| 191 | +| `q` | string | No | Search query for skill title/content. | |
| 192 | +| `category` | string | No | Optional skills category filter. | |
| 193 | +| `limit` | number | No | Max results to return. | |
| 194 | + |
| 195 | +**Example prompts:** |
| 196 | + |
| 197 | +- "List skills for Effect testing." |
| 198 | +- "Find skills for service architecture." |
| 199 | + |
| 200 | +--- |
| 201 | + |
| 202 | +### 5. `get_skill` |
| 203 | + |
| 204 | +Get full details for a specific skill by slug, including full guidance content. |
| 205 | + |
| 206 | +| Parameter | Type | Required | Description | |
| 207 | +|-----------|------|----------|-------------| |
| 208 | +| `slug` | string | Yes | Skill slug identifier. | |
| 209 | + |
| 210 | +**Example prompts:** |
| 211 | + |
| 212 | +- "Get the skill for effect-service." |
| 213 | +- "Show skill details for a testing workflow." |
| 214 | + |
| 215 | +--- |
| 216 | + |
184 | 217 | ## HTTP API |
185 | 218 |
|
186 | 219 | When you use the **hosted** server, the MCP server forwards tool calls to the HTTP API for patterns and rules only. You can also call the API directly (e.g. from scripts or CI) with the same API key. **MCP tools do not call paid endpoints** — analysis, review, refactoring, and generation are available only when using the HTTP API or paid CLI directly. |
@@ -217,7 +250,7 @@ Full request/response shapes: see [MCP Server API Reference](../../docs/mcp-serv |
217 | 250 |
|
218 | 251 | ## Service Tiers |
219 | 252 |
|
220 | | -- **MCP (free):** Patterns and rule catalog only — `search_patterns`, `get_pattern`, `list_analysis_rules`. Rate limits apply (e.g. 100 requests per 15 minutes per key). MCP cannot call paid endpoints. |
| 253 | +- **MCP (free):** Patterns, skills, and rule catalog — `search_patterns`, `get_pattern`, `list_analysis_rules`, `list_skills`, `get_skill`. Rate limits apply (e.g. 100 requests per 15 minutes per key). MCP cannot call paid endpoints. |
221 | 254 | - **Paid (HTTP API / CLI only):** Code analysis, code review, consistency analysis, apply refactoring, generate pattern code, and higher limits. Use the HTTP API or paid CLI; these capabilities are not available via MCP. |
222 | 255 |
|
223 | 256 | --- |
|
0 commit comments