You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/mcp-server/README-END-USER.md
+34-6Lines changed: 34 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -128,7 +128,7 @@ Never commit API keys; use environment variables or your IDE's secret storage.
128
128
129
129
---
130
130
131
-
## MCP Tools (Free Tier)
131
+
## MCP Tools
132
132
133
133
The MCP server exposes **exactly five tools** in production and staging. No other tools (including code analysis or review) are available via MCP.
134
134
@@ -178,6 +178,27 @@ No parameters.
178
178
- "List all analysis rules."
179
179
- "What rules does the analyzer use?"
180
180
181
+
---
182
+
183
+
### 4. `list_skills`
184
+
185
+
Search Effect-TS skills by query and optional category.
186
+
187
+
| Parameter | Type | Required | Description |
188
+
|-----------|------|----------|-------------|
189
+
|`q`| string | No | Search query string. |
190
+
|`category`| string | No | Skill category filter. |
191
+
|`limit`| number | No | Maximum results (1–100). |
192
+
|`format`| string | No |`markdown`, `json`, or `both`. |
193
+
194
+
### 5. `get_skill`
195
+
196
+
Get full details for one skill by slug.
197
+
198
+
| Parameter | Type | Required | Description |
199
+
|-----------|------|----------|-------------|
200
+
|`slug`| string | Yes | Skill slug identifier. |
201
+
181
202
**Debug / local only:** The tool `get_mcp_config` is not part of the default production/staging surface; it only appears when `MCP_DEBUG=true` or `MCP_ENV=local`.
182
203
183
204
---
@@ -216,23 +237,25 @@ Get full details for a specific skill by slug, including full guidance content.
216
237
217
238
## HTTP API
218
239
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.
240
+
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 analysis/refactoring/generation endpoints** — those are available only when using the HTTP API or CLI directly.
220
241
221
242
-**Auth:**`x-api-key: <PATTERN_API_KEY>` on requests (or query param in some setups).
| GET |`/api/skills`| List/search skills (`q`, `category`, `limit`). |
255
+
| GET |`/api/skills/[slug]`| Get skill by slug. |
233
256
| POST |`/api/list-rules`| List rules metadata (read-only catalog). |
234
257
235
-
**Paid (HTTP API / CLI only — not exposed via MCP):**
258
+
**HTTP API / CLI only (not exposed via MCP):**
236
259
237
260
| Method | Path | Purpose |
238
261
|--------|------|---------|
@@ -248,10 +271,15 @@ Full request/response shapes: see [MCP Server API Reference](../../docs/mcp-serv
248
271
249
272
---
250
273
251
-
## Service Tiers
274
+
## Capability Boundaries
252
275
276
+
<<<<<<< codex/pr-3-remove-tier-references
277
+
-**MCP surface:** 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 does not call analysis/refactoring/generation endpoints.
278
+
-**HTTP API / CLI surface:** Code analysis, code review, consistency analysis, apply refactoring, and generate pattern code.
279
+
=======
253
280
-**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.
254
281
-**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.
282
+
>>>>>>> main
255
283
256
284
---
257
285
@@ -278,7 +306,7 @@ Full request/response shapes: see [MCP Server API Reference](../../docs/mcp-serv
278
306
279
307
-**Backend not running:** If using local API, ensure `bun run dev` is running in `packages/mcp-server` and the API is at `http://localhost:3000`.
280
308
-**Wrong URL:** If using hosted, set `EFFECT_PATTERNS_API_URL` to `https://effect-patterns-mcp.vercel.app` (or staging).
281
-
-**Auth:** 401/402 usually mean invalid or missing API key. Check the key and that it's passed to the process that runs the MCP server.
309
+
-**Auth:** 401/403 usually mean invalid or missing API key. Check the key and that it's passed to the process that runs the MCP server.
0 commit comments