@yawlabs/ctxlint 0.25.0 → 0.25.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.pre-commit-hooks.yaml +10 -10
- package/AGENT_SESSION_LINT_SPEC.md +632 -612
- package/AGENT_SKILL_LINT_SPEC.md +20 -18
- package/CONTEXT_LINT_SPEC.md +809 -782
- package/MCP_CONFIG_LINT_SPEC.md +434 -419
- package/README.md +553 -553
- package/agent-session-lint-rules.json +243 -243
- package/bin/ctxlint.mjs +410 -360
- package/context-lint-rules.json +695 -754
- package/dist/index.js +234 -252
- package/mcp-config-lint-rules.json +45 -162
- package/package.json +23 -25
package/MCP_CONFIG_LINT_SPEC.md
CHANGED
|
@@ -1,419 +1,434 @@
|
|
|
1
|
-
# MCP Server Configuration Linting Specification
|
|
2
|
-
|
|
3
|
-
**Version:** 1.0.0-draft
|
|
4
|
-
**Date:** 2026-04-07
|
|
5
|
-
**MCP Spec Compatibility:** 2025-11-25 (Streamable HTTP)
|
|
6
|
-
**Maintained by:** [Yaw Labs](https://yaw.sh) / [ctxlint](https://github.com/YawLabs/ctxlint)
|
|
7
|
-
**License:** CC BY 4.0
|
|
8
|
-
|
|
9
|
-
---
|
|
10
|
-
|
|
11
|
-
## What is this?
|
|
12
|
-
|
|
13
|
-
MCP server configuration files (`.mcp.json`, `.cursor/mcp.json`, `.vscode/mcp.json`, etc.) define which tools an AI agent can access. They are a context interface — alongside instruction files like `CLAUDE.md` and `.cursorrules`, they shape what an agent knows and can do.
|
|
14
|
-
|
|
15
|
-
This specification defines a standard set of lint rules for validating MCP server configurations across all major AI coding clients. It is tool-agnostic: any linter, IDE extension, CI check, or AI agent can implement these rules.
|
|
16
|
-
|
|
17
|
-
The specification includes:
|
|
18
|
-
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
|
34
|
-
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
- [1.
|
|
47
|
-
- [1.
|
|
48
|
-
- [1.
|
|
49
|
-
- [1.
|
|
50
|
-
- [1.
|
|
51
|
-
- [
|
|
52
|
-
|
|
53
|
-
- [2.
|
|
54
|
-
- [2.
|
|
55
|
-
- [2.
|
|
56
|
-
- [2.
|
|
57
|
-
- [2.
|
|
58
|
-
- [2.
|
|
59
|
-
- [2.
|
|
60
|
-
- [
|
|
61
|
-
- [
|
|
62
|
-
- [
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
"
|
|
84
|
-
"
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
"
|
|
98
|
-
"
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
}
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
|
113
|
-
| `
|
|
114
|
-
| `
|
|
115
|
-
| `
|
|
116
|
-
| `
|
|
117
|
-
| `
|
|
118
|
-
| `
|
|
119
|
-
| `
|
|
120
|
-
| `
|
|
121
|
-
| `
|
|
122
|
-
| `
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
|
133
|
-
| `.
|
|
134
|
-
| `.
|
|
135
|
-
| `.
|
|
136
|
-
| `.
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
|
145
|
-
| `~/.claude
|
|
146
|
-
| `~/.
|
|
147
|
-
|
|
|
148
|
-
|
|
|
149
|
-
|
|
|
150
|
-
| `~/.
|
|
151
|
-
|
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
|
160
|
-
|
|
|
161
|
-
|
|
|
162
|
-
|
|
|
163
|
-
|
|
|
164
|
-
|
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
**
|
|
178
|
-
|
|
179
|
-
**
|
|
180
|
-
|
|
181
|
-
**
|
|
182
|
-
|
|
183
|
-
**
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
|
219
|
-
|
|
|
220
|
-
| `mcp-schema/
|
|
221
|
-
| `mcp-schema/
|
|
222
|
-
| `mcp-schema/
|
|
223
|
-
| `mcp-schema/
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
|
237
|
-
|
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
|
300
|
-
|
|
301
|
-
|
|
|
302
|
-
|
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
###
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
###
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
-
|
|
419
|
-
-
|
|
1
|
+
# MCP Server Configuration Linting Specification
|
|
2
|
+
|
|
3
|
+
**Version:** 1.0.0-draft
|
|
4
|
+
**Date:** 2026-04-07
|
|
5
|
+
**MCP Spec Compatibility:** 2025-11-25 (Streamable HTTP)
|
|
6
|
+
**Maintained by:** [Yaw Labs](https://yaw.sh) / [ctxlint](https://github.com/YawLabs/ctxlint)
|
|
7
|
+
**License:** CC BY 4.0
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## What is this?
|
|
12
|
+
|
|
13
|
+
MCP server configuration files (`.mcp.json`, `.cursor/mcp.json`, `.vscode/mcp.json`, etc.) define which tools an AI agent can access. They are a context interface — alongside instruction files like `CLAUDE.md` and `.cursorrules`, they shape what an agent knows and can do.
|
|
14
|
+
|
|
15
|
+
This specification defines a standard set of lint rules for validating MCP server configurations across all major AI coding clients. It is tool-agnostic: any linter, IDE extension, CI check, or AI agent can implement these rules.
|
|
16
|
+
|
|
17
|
+
The specification includes:
|
|
18
|
+
|
|
19
|
+
- A complete reference of MCP config file locations, formats, and client-specific behaviors
|
|
20
|
+
- 29 lint rules organized into 8 categories with defined severities
|
|
21
|
+
- A machine-readable rule catalog ([`mcp-config-lint-rules.json`](./mcp-config-lint-rules.json))
|
|
22
|
+
- Auto-fix definitions for rules that support automated correction
|
|
23
|
+
|
|
24
|
+
**Reference implementation:** [ctxlint](https://github.com/YawLabs/ctxlint) (v0.4.0+)
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## Related specifications
|
|
29
|
+
|
|
30
|
+
This spec is part of a family of open specifications maintained by Yaw Labs for MCP tooling:
|
|
31
|
+
|
|
32
|
+
| Spec | Scope | Input |
|
|
33
|
+
| -------------------------------------------------------------------------------------------------- | ------------------------------------------ | --------------------------------------------------------- |
|
|
34
|
+
| **mcp-config-lint** (this spec) | Static analysis of MCP client config files | `.cursor/mcp.json`, `.vscode/mcp.json`, `.mcp.json`, etc. |
|
|
35
|
+
| [**mcp-compliance**](https://github.com/YawLabs/mcp-compliance/blob/master/MCP_COMPLIANCE_SPEC.md) | Runtime testing of live MCP servers | A live server URL + transport |
|
|
36
|
+
|
|
37
|
+
The two are **complementary, not overlapping**. `mcp-config-lint` catches problems before deploy by reading JSON on disk; `mcp-compliance` catches problems after deploy by speaking the protocol to a running server. A production setup typically runs both.
|
|
38
|
+
|
|
39
|
+
Both specs target MCP spec version `2025-11-25` and ship machine-readable rule catalogs with stable rule IDs.
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Table of contents
|
|
44
|
+
|
|
45
|
+
- [1. MCP Config Landscape Reference](#1-mcp-config-landscape-reference)
|
|
46
|
+
- [1.1 Config format](#11-config-format)
|
|
47
|
+
- [1.2 Server entry fields](#12-server-entry-fields)
|
|
48
|
+
- [1.3 File locations by client](#13-file-locations-by-client)
|
|
49
|
+
- [1.4 Environment variable syntax](#14-environment-variable-syntax)
|
|
50
|
+
- [1.5 Override precedence](#15-override-precedence)
|
|
51
|
+
- [1.6 Platform-specific behaviors](#16-platform-specific-behaviors)
|
|
52
|
+
- [2. Lint Rules](#2-lint-rules)
|
|
53
|
+
- [2.1 mcp-schema — structural validation](#21-mcp-schema--structural-validation)
|
|
54
|
+
- [2.2 mcp-security — hardcoded secrets](#22-mcp-security--hardcoded-secrets)
|
|
55
|
+
- [2.3 mcp-commands — stdio command validation](#23-mcp-commands--stdio-command-validation)
|
|
56
|
+
- [2.4 mcp-deprecated — deprecated patterns](#24-mcp-deprecated--deprecated-patterns)
|
|
57
|
+
- [2.5 mcp-env — environment variable validation](#25-mcp-env--environment-variable-validation)
|
|
58
|
+
- [2.6 mcp-urls — URL validation](#26-mcp-urls--url-validation)
|
|
59
|
+
- [2.7 mcp-consistency — cross-file consistency](#27-mcp-consistency--cross-file-consistency)
|
|
60
|
+
- [2.8 mcp-redundancy — unnecessary configs](#28-mcp-redundancy--unnecessary-configs)
|
|
61
|
+
- [3. Rule Catalog (machine-readable)](#3-rule-catalog-machine-readable)
|
|
62
|
+
- [4. Implementing This Specification](#4-implementing-this-specification)
|
|
63
|
+
- [5. Contributing](#5-contributing)
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## 1. MCP Config Landscape Reference
|
|
68
|
+
|
|
69
|
+
This section documents the full MCP server configuration landscape as of April 2026. Implementors should treat this as the authoritative cross-client reference for file locations, formats, and behaviors.
|
|
70
|
+
|
|
71
|
+
### 1.1 Config format
|
|
72
|
+
|
|
73
|
+
Every MCP config file is a JSON object with a root key containing named server entries. Each server entry describes how the client connects to one MCP server.
|
|
74
|
+
|
|
75
|
+
There are two active transport types:
|
|
76
|
+
|
|
77
|
+
**stdio** — the client launches a local subprocess and communicates over stdin/stdout using JSON-RPC:
|
|
78
|
+
|
|
79
|
+
```json
|
|
80
|
+
{
|
|
81
|
+
"mcpServers": {
|
|
82
|
+
"my-server": {
|
|
83
|
+
"command": "npx",
|
|
84
|
+
"args": ["-y", "@example/mcp-server"],
|
|
85
|
+
"env": { "DEBUG": "true" }
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
**Streamable HTTP** — the client connects to a remote URL over HTTP:
|
|
92
|
+
|
|
93
|
+
```json
|
|
94
|
+
{
|
|
95
|
+
"mcpServers": {
|
|
96
|
+
"my-server": {
|
|
97
|
+
"type": "http",
|
|
98
|
+
"url": "https://my-server.example.com/mcp",
|
|
99
|
+
"headers": {
|
|
100
|
+
"Authorization": "Bearer ${API_KEY}"
|
|
101
|
+
}
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
**SSE (Server-Sent Events)** — deprecated as of the March 2025 MCP spec update. Uses `"type": "sse"`. Still supported by most clients but should be migrated to Streamable HTTP.
|
|
108
|
+
|
|
109
|
+
### 1.2 Server entry fields
|
|
110
|
+
|
|
111
|
+
| Field | Type | Transport | Required | Description |
|
|
112
|
+
| --------------- | -------------------------------- | --------- | -------- | ------------------------------------------------------------------------- |
|
|
113
|
+
| `type` | `"stdio"` \| `"http"` \| `"sse"` | All | No | Transport protocol. Defaults to `stdio` if `command` is present. |
|
|
114
|
+
| `command` | string | stdio | Yes | Executable to launch as a subprocess. |
|
|
115
|
+
| `args` | string[] | stdio | No | Arguments passed to the command. |
|
|
116
|
+
| `env` | Record<string, string> | stdio | No | Environment variables for the subprocess. |
|
|
117
|
+
| `url` | string | http, sse | Yes | Remote endpoint URL. |
|
|
118
|
+
| `headers` | Record<string, string> | http, sse | No | HTTP headers sent with every request. |
|
|
119
|
+
| `disabled` | boolean | All | No | Whether the server is disabled. (Cline-specific) |
|
|
120
|
+
| `autoApprove` | string[] | All | No | Tool names to auto-approve without user confirmation. (Cline-specific) |
|
|
121
|
+
| `timeout` | number (ms) | All | No | Max response wait time. Default: 60000. (Amazon Q-specific) |
|
|
122
|
+
| `oauth` | object | http | No | OAuth 2.0 configuration. (Claude Code-specific) |
|
|
123
|
+
| `headersHelper` | string | http | No | Shell command that outputs JSON headers to stdout. (Claude Code-specific) |
|
|
124
|
+
|
|
125
|
+
### 1.3 File locations by client
|
|
126
|
+
|
|
127
|
+
#### Project-level configs
|
|
128
|
+
|
|
129
|
+
These live relative to the project root and are typically committed to version control.
|
|
130
|
+
|
|
131
|
+
| File path | Client | Root key | Notes |
|
|
132
|
+
| ----------------------------- | ------------------------ | ------------- | -------------------------------------------------------- |
|
|
133
|
+
| `.mcp.json` | Claude Code | `mcpServers` | The universal project-level convention. |
|
|
134
|
+
| `.cursor/mcp.json` | Cursor | `mcpServers` | |
|
|
135
|
+
| `.vscode/mcp.json` | VS Code / GitHub Copilot | **`servers`** | Only client that uses `servers` instead of `mcpServers`. |
|
|
136
|
+
| `.amazonq/mcp.json` | Amazon Q Developer | `mcpServers` | Server names must be unique across project + global. |
|
|
137
|
+
| `.continue/mcpServers/*.json` | Continue.dev | varies | Accepts config files from any client format. |
|
|
138
|
+
|
|
139
|
+
#### User/global-level configs
|
|
140
|
+
|
|
141
|
+
These are user-specific and not committed to version control.
|
|
142
|
+
|
|
143
|
+
| File path | Client | Root key | Platform |
|
|
144
|
+
| ------------------------------------------------------------------------------- | -------------- | ------------ | -------- |
|
|
145
|
+
| `~/.claude.json` | Claude Code | `mcpServers` | All |
|
|
146
|
+
| `~/.claude/settings.json` | Claude Code | `mcpServers` | All |
|
|
147
|
+
| `~/.cursor/mcp.json` | Cursor | `mcpServers` | All |
|
|
148
|
+
| `~/Library/Application Support/Claude/claude_desktop_config.json` | Claude Desktop | `mcpServers` | macOS |
|
|
149
|
+
| `%APPDATA%\Claude\claude_desktop_config.json` | Claude Desktop | `mcpServers` | Windows |
|
|
150
|
+
| `~/.codeium/windsurf/mcp_config.json` | Windsurf | `mcpServers` | All |
|
|
151
|
+
| `~/.aws/amazonq/mcp.json` | Amazon Q | `mcpServers` | All |
|
|
152
|
+
| VS Code globalStorage `saoudrizwan.claude-dev/settings/cline_mcp_settings.json` | Cline | `mcpServers` | All |
|
|
153
|
+
|
|
154
|
+
### 1.4 Environment variable syntax
|
|
155
|
+
|
|
156
|
+
Different clients use different syntax for referencing environment variables in config values.
|
|
157
|
+
|
|
158
|
+
| Client | Syntax | Default value support | Example |
|
|
159
|
+
| -------------- | -------------------- | --------------------- | ------------------------ |
|
|
160
|
+
| Claude Code | `${VAR}` | `${VAR:-default}` | `${API_KEY}` |
|
|
161
|
+
| Cursor | `${env:VAR}` | No | `${env:API_KEY}` |
|
|
162
|
+
| Continue.dev | `${{ secrets.VAR }}` | No | `${{ secrets.API_KEY }}` |
|
|
163
|
+
| Windsurf | `${env:VAR}` | No | `${env:API_KEY}` |
|
|
164
|
+
| Claude Desktop | Not supported | N/A | Literal values only |
|
|
165
|
+
| Amazon Q | Not supported | N/A | Literal values only |
|
|
166
|
+
|
|
167
|
+
Env var expansion applies to `command`, `args`, `env`, `url`, and `headers` fields (where supported).
|
|
168
|
+
|
|
169
|
+
### 1.5 Override precedence
|
|
170
|
+
|
|
171
|
+
When the same server name exists at multiple scopes, the most specific scope wins.
|
|
172
|
+
|
|
173
|
+
**Claude Code** (three-tier):
|
|
174
|
+
|
|
175
|
+
1. **Local** (highest) — per-user, per-project overrides in `~/.claude.json` under a project path key
|
|
176
|
+
2. **Project** — `.mcp.json` at the repo root
|
|
177
|
+
3. **User** (lowest) — `~/.claude.json` top-level `mcpServers`
|
|
178
|
+
|
|
179
|
+
**Cursor:** project `.cursor/mcp.json` overrides global `~/.cursor/mcp.json`.
|
|
180
|
+
|
|
181
|
+
**Amazon Q:** workspace `.amazonq/mcp.json` overrides global `~/.aws/amazonq/mcp.json`. Server names must be unique across both.
|
|
182
|
+
|
|
183
|
+
**VS Code:** workspace `.vscode/mcp.json` overrides user-level configuration.
|
|
184
|
+
|
|
185
|
+
**Windsurf, Cline:** Single global config. No override behavior.
|
|
186
|
+
|
|
187
|
+
### 1.6 Platform-specific behaviors
|
|
188
|
+
|
|
189
|
+
**Windows + npx (stdio):** On native Windows (not WSL), `npx` commands must be wrapped with `cmd /c`:
|
|
190
|
+
|
|
191
|
+
```json
|
|
192
|
+
{
|
|
193
|
+
"command": "cmd",
|
|
194
|
+
"args": ["/c", "npx", "-y", "@example/mcp-server"]
|
|
195
|
+
}
|
|
196
|
+
```
|
|
197
|
+
|
|
198
|
+
Without this wrapper, the subprocess fails to spawn. This is the most common Windows MCP config issue.
|
|
199
|
+
|
|
200
|
+
**Claude.ai custom connectors:** Only support remote MCP servers over Streamable HTTP. No stdio support — browsers cannot launch local subprocesses. stdio-only servers must be hosted remotely to be used with Claude.ai.
|
|
201
|
+
|
|
202
|
+
---
|
|
203
|
+
|
|
204
|
+
## 2. Lint Rules
|
|
205
|
+
|
|
206
|
+
29 rules organized into 8 categories. Each rule has a unique ID, severity level, trigger condition, and message template.
|
|
207
|
+
|
|
208
|
+
Severity levels:
|
|
209
|
+
|
|
210
|
+
- **error** — the config is broken or has a security issue. Should fail CI.
|
|
211
|
+
- **warning** — the config has a likely problem. May or may not fail CI depending on strictness.
|
|
212
|
+
- **info** — the config has a potential improvement. Never fails CI.
|
|
213
|
+
|
|
214
|
+
### 2.1 mcp-schema — structural validation
|
|
215
|
+
|
|
216
|
+
Validates that the config file is well-formed JSON with the correct structure for its target client.
|
|
217
|
+
|
|
218
|
+
| Rule ID | Severity | Trigger | Message |
|
|
219
|
+
| -------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
220
|
+
| `mcp-schema/invalid-json` | error | File is not valid JSON | `MCP config is not valid JSON: {parseError}` |
|
|
221
|
+
| `mcp-schema/wrong-root-key` | error | Root key doesn't match expected key for the client | `{file} must use "{expected}" as root key, not "{actual}"` |
|
|
222
|
+
| `mcp-schema/missing-root-key` | error | No recognized root key (`mcpServers` or `servers`) | `MCP config has no "{expected}" key` |
|
|
223
|
+
| `mcp-schema/missing-command` | error | stdio server has no `command` field | `Server "{name}" has no "command" field` |
|
|
224
|
+
| `mcp-schema/missing-url` | error | http/sse server has no `url` field | `Server "{name}" has no "url" field` |
|
|
225
|
+
| `mcp-schema/no-name-field` | error | A server entry's key (its name) is the empty string | `Server name cannot be empty` |
|
|
226
|
+
| `mcp-schema/unknown-transport` | warning | Transport cannot be classified: a `type` outside `stdio`/`http`/`sse`, a non-string `type`, or an entry with neither `command` nor `url` | `Server "{name}" has unknown transport type "{type}"` (or, with no classifiable fields at all: `Server "{name}" has no recognizable transport — expected "command", "url", or a valid "type"`) |
|
|
227
|
+
| `mcp-schema/ambiguous-transport` | warning | Server has both `command` and `url` fields | `Server "{name}" has both "command" and "url" — transport is ambiguous` |
|
|
228
|
+
| `mcp-schema/empty-servers` | info | Root key exists but contains no server entries | `MCP config has no server entries` |
|
|
229
|
+
|
|
230
|
+
**Auto-fixable:** `wrong-root-key` — rename the root key to match the expected key.
|
|
231
|
+
|
|
232
|
+
### 2.2 mcp-security — hardcoded secrets
|
|
233
|
+
|
|
234
|
+
Detects secrets committed to version control in MCP config files. The three secret rules (`hardcoded-bearer`, `hardcoded-api-key`, `secret-in-url`) only flag issues in git-tracked files — an untracked config leaks nothing to teammates. `mcp-security/http-no-tls` is a transport concern, independent of version control, and fires regardless of git tracking. When the tracked status cannot be determined at all (git unavailable or failing, as opposed to a determined "untracked"), the linter says so via `mcp-security/secret-scan-skipped` instead of silently passing a possibly-tracked file.
|
|
235
|
+
|
|
236
|
+
| Rule ID | Severity | Trigger | Message |
|
|
237
|
+
| ---------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
|
|
238
|
+
| `mcp-security/hardcoded-bearer` | error | `Authorization` header contains a literal Bearer token (not an env var reference) in a git-tracked file | `Server "{name}" has a hardcoded Bearer token in a git-tracked file` |
|
|
239
|
+
| `mcp-security/hardcoded-api-key` | error | Header or env value matches known API key patterns (or the high-entropy heuristic below) in a git-tracked file | `Server "{name}" has a hardcoded API key in a git-tracked file` |
|
|
240
|
+
| `mcp-security/secret-in-url` | error | URL contains query params that look like secrets (`?key=`, `?token=`, `?api_key=`) in a git-tracked file | `Server "{name}" has a secret in the URL query string` |
|
|
241
|
+
| `mcp-security/secret-scan-skipped` | info | Git-tracked status could not be determined (git unavailable/failing — not merely untracked), so the three git-gated secret rules were skipped | `Could not determine git-tracked status of {file}; hardcoded-secret rules were skipped` |
|
|
242
|
+
| `mcp-security/http-no-tls` | warning | URL uses `http://` for a non-loopback target (loopback = `localhost`, `[::1]`, `127.0.0.0/8`) | `Server "{name}" uses HTTP without TLS` |
|
|
243
|
+
|
|
244
|
+
**Known API key patterns:**
|
|
245
|
+
|
|
246
|
+
```
|
|
247
|
+
sk-ant-[A-Za-z0-9_-]{20,} # Anthropic
|
|
248
|
+
sk-proj-[A-Za-z0-9_-]{20,} # OpenAI project-scoped
|
|
249
|
+
sk-[a-zA-Z0-9]{20,} # OpenAI classic / generic (alphanumeric-only:
|
|
250
|
+
# [-_] would swallow kebab-case identifiers)
|
|
251
|
+
ghp_[a-zA-Z0-9]{36} # GitHub personal access token
|
|
252
|
+
ghu_[a-zA-Z0-9]{36} # GitHub user token
|
|
253
|
+
github_pat_[a-zA-Z0-9_]{80,} # GitHub fine-grained PAT
|
|
254
|
+
xoxb-[0-9]{10,} # Slack bot token
|
|
255
|
+
xoxp-[0-9]{10,} # Slack user token
|
|
256
|
+
AKIA[0-9A-Z]{16} # AWS access key ID
|
|
257
|
+
AGE-SECRET-KEY-1[a-zA-Z0-9]+ # age encryption secret key
|
|
258
|
+
glpat-[a-zA-Z0-9_\-]{20} # GitLab personal access token
|
|
259
|
+
sq0atp-[a-zA-Z0-9_\-]{22} # Square access token
|
|
260
|
+
```
|
|
261
|
+
|
|
262
|
+
**High-entropy heuristic:** additionally flag an env value > 20 characters that is entirely alphanumeric/base64 characters, is not an env var reference (`${...}`, `${{ ... }}`), AND whose variable name contains a secret-suggesting keyword (`KEY`, `TOKEN`, `SECRET`, `PASSWORD`, `AUTH`, `CREDENTIAL`, `SIGNING`, `SESSION`, `COOKIE`, ...). The name gate is deliberate: without it, build IDs, commit SHAs, version strings, and feature-flag tokens false-positive.
|
|
263
|
+
|
|
264
|
+
**Auto-fixable:** `hardcoded-bearer`, `hardcoded-api-key` — replace literal value with an env var reference derived from the server name (e.g., `MY_SERVER_API_KEY`).
|
|
265
|
+
|
|
266
|
+
### 2.3 mcp-commands — stdio command validation
|
|
267
|
+
|
|
268
|
+
Validates that stdio server commands and file-path arguments are viable.
|
|
269
|
+
|
|
270
|
+
| Rule ID | Severity | Trigger | Message |
|
|
271
|
+
| ------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
|
272
|
+
| `mcp-commands/windows-npx-no-wrapper` | error | Platform is Windows and `command` is `npx` without `cmd /c` wrapper | `Server "{name}": npx requires "cmd /c" wrapper on Windows` |
|
|
273
|
+
| `mcp-commands/command-not-found` | warning | `command` is a relative path (`./`, `../`) that doesn't exist (project-scope configs only) | `Server "{name}": command "{command}" not found` |
|
|
274
|
+
| `mcp-commands/args-path-missing` | warning | An arg matches a file path pattern and the file doesn't exist (relative paths: project-scope configs only; absolute paths: every scope) | `Server "{name}": arg "{arg}" looks like a file path but doesn't exist` |
|
|
275
|
+
|
|
276
|
+
**Notes:**
|
|
277
|
+
|
|
278
|
+
- `windows-npx-no-wrapper` should only flag project-level configs, not global configs (the user may be developing cross-platform).
|
|
279
|
+
- `args-path-missing` should only check args that look like file paths (contain `/` with a file extension, or start with `./` / `../`). Skip npm package names and flags.
|
|
280
|
+
- Do not validate that system commands (`npx`, `node`, `python`) exist on PATH — that is a runtime concern, not a config concern.
|
|
281
|
+
|
|
282
|
+
**Auto-fixable:** `windows-npx-no-wrapper` — rewrite `{"command": "npx", "args": [...]}` to `{"command": "cmd", "args": ["/c", "npx", ...]}`.
|
|
283
|
+
|
|
284
|
+
### 2.4 mcp-deprecated — deprecated patterns
|
|
285
|
+
|
|
286
|
+
Flags usage of deprecated MCP transport protocols and patterns.
|
|
287
|
+
|
|
288
|
+
| Rule ID | Severity | Trigger | Message |
|
|
289
|
+
| ------------------------------ | -------- | --------------------------- | -------------------------------------------------------------------------------------- |
|
|
290
|
+
| `mcp-deprecated/sse-transport` | warning | Server uses `"type": "sse"` | `Server "{name}" uses deprecated SSE transport — use "http" (Streamable HTTP) instead` |
|
|
291
|
+
|
|
292
|
+
**Auto-fixable:** `sse-transport` — replace `"sse"` with `"http"`.
|
|
293
|
+
|
|
294
|
+
### 2.5 mcp-env — environment variable validation
|
|
295
|
+
|
|
296
|
+
Validates environment variable references for correctness and client compatibility.
|
|
297
|
+
|
|
298
|
+
| Rule ID | Severity | Trigger | Message |
|
|
299
|
+
| ------------------------- | -------- | --------------------------------------------------------- | ---------------------------------------------------------- |
|
|
300
|
+
| `mcp-env/wrong-syntax` | error | Env var reference uses wrong syntax for the target client | `Server "{name}": {client} uses {expected}, not {actual}` |
|
|
301
|
+
| `mcp-env/unset-variable` | info | Referenced env var is not set in the current environment | `Server "{name}": environment variable "{var}" is not set` |
|
|
302
|
+
| `mcp-env/empty-env-block` | info | `env` object is present but empty | `Server "{name}": empty "env" block can be removed` |
|
|
303
|
+
|
|
304
|
+
**Syntax validation matrix:**
|
|
305
|
+
|
|
306
|
+
| Config file | Expected syntax | Flag if found |
|
|
307
|
+
| ----------------------------- | -------------------- | ------------------------------- |
|
|
308
|
+
| `.mcp.json` | `${VAR}` | `${env:VAR}` |
|
|
309
|
+
| `.cursor/mcp.json` | `${env:VAR}` | `${VAR}` (bare, without `env:`) |
|
|
310
|
+
| `.continue/mcpServers/*.json` | `${{ secrets.VAR }}` | `${VAR}` or `${env:VAR}` |
|
|
311
|
+
| All others | `${VAR}` | — |
|
|
312
|
+
|
|
313
|
+
**Notes:**
|
|
314
|
+
|
|
315
|
+
- `unset-variable` is intentionally `info` severity. Many env vars are set only in CI, `.env` files, or shell profiles that aren't available during linting.
|
|
316
|
+
- `unset-variable` is skipped entirely for Continue configs — their `${{ secrets.VAR }}` references resolve from GitHub Actions secrets, not the local environment, so every correct Continue config would false-positive.
|
|
317
|
+
- Scan all string values in `command`, `args`, `url`, `headers`, and `env` for env var references.
|
|
318
|
+
|
|
319
|
+
**Auto-fixable:** `wrong-syntax` — rewrite to the correct syntax for the target client.
|
|
320
|
+
|
|
321
|
+
### 2.6 mcp-urls — URL validation
|
|
322
|
+
|
|
323
|
+
Validates remote server URLs for correctness and team usability.
|
|
324
|
+
|
|
325
|
+
| Rule ID | Severity | Trigger | Message |
|
|
326
|
+
| -------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
|
327
|
+
| `mcp-urls/malformed-url` | error | URL is not parseable (after skipping env var placeholders) | `Server "{name}": invalid URL "{url}"` |
|
|
328
|
+
| `mcp-urls/localhost-in-project-config` | warning | URL host is a loopback address (`localhost`, `[::1]`, `127.0.0.0/8` — the same set `http-no-tls` exempts) in a project-level config | `Server "{name}": loopback URL in project config won't work for teammates` |
|
|
329
|
+
| `mcp-urls/missing-path` | info | URL has no path or just `/` | `Server "{name}": URL has no path — most MCP servers expect /mcp` |
|
|
330
|
+
|
|
331
|
+
**Notes:**
|
|
332
|
+
|
|
333
|
+
- If the URL contains env var references (`${...}`), skip `malformed-url` — it cannot be validated statically.
|
|
334
|
+
- `localhost-in-project-config` should only flag project-scoped files (committed to version control by convention), not global configs where loopback URLs are expected. Strip IPv6 brackets before classifying the host, and treat the whole `127.0.0.0/8` block as loopback — `127.0.0.2` is just as unreachable for a teammate as `127.0.0.1`.
|
|
335
|
+
|
|
336
|
+
### 2.7 mcp-consistency — cross-file consistency
|
|
337
|
+
|
|
338
|
+
Compares MCP configs across multiple files in the same project. This is a cross-file check that runs after all individual configs are parsed.
|
|
339
|
+
|
|
340
|
+
| Rule ID | Severity | Trigger | Message |
|
|
341
|
+
| ---------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
|
342
|
+
| `mcp-consistency/same-server-different-config` | warning | Server with the same name exists in 2+ same-scope config files (project-project or user-user) with different URLs or commands — cross-scope pairs are client precedence, not drift | `Server "{name}" is configured differently in {file1} and {file2}` |
|
|
343
|
+
| `mcp-consistency/duplicate-server-name` | warning | Same server name appears more than once in a single file | `Duplicate server name "{name}" in {file} — only the last definition is used` |
|
|
344
|
+
| `mcp-consistency/missing-from-client` | info | Server exists in `.mcp.json` but is absent from another client's project config that also exists | `Server "{name}" is in .mcp.json but missing from {file}` |
|
|
345
|
+
|
|
346
|
+
**Notes:**
|
|
347
|
+
|
|
348
|
+
- For `same-server-different-config`, compare `url`/`command`/`args`. Ignore `headers` differences (auth tokens intentionally differ per user).
|
|
349
|
+
- `missing-from-client` is informational only. Teams may intentionally have different server sets per client.
|
|
350
|
+
|
|
351
|
+
### 2.8 mcp-redundancy — unnecessary configs
|
|
352
|
+
|
|
353
|
+
Flags configs that may be unnecessary or stale.
|
|
354
|
+
|
|
355
|
+
| Rule ID | Severity | Trigger | Message |
|
|
356
|
+
| ---------------------------------------- | -------- | ------------------------------------------------------------------ | ----------------------------------------------------------------------------- |
|
|
357
|
+
| `mcp-redundancy/disabled-server` | info | Server has `"disabled": true` | `Server "{name}" is disabled — consider removing if no longer needed` |
|
|
358
|
+
| `mcp-redundancy/identical-across-scopes` | info | Same server with identical config at both project and global scope | `Server "{name}" is identically configured in {projectFile} and {globalFile}` |
|
|
359
|
+
|
|
360
|
+
**Notes:**
|
|
361
|
+
|
|
362
|
+
- The `disabled` field is Cline-specific (see [Section 1.2](#12-server-entry-fields)), but `disabled-server` fires on any client's config that carries it — a stale `"disabled": true` is dead weight regardless of which client wrote it.
|
|
363
|
+
|
|
364
|
+
---
|
|
365
|
+
|
|
366
|
+
## 3. Rule Catalog (machine-readable)
|
|
367
|
+
|
|
368
|
+
A machine-readable JSON catalog of all rules is available at [`mcp-config-lint-rules.json`](./mcp-config-lint-rules.json).
|
|
369
|
+
|
|
370
|
+
The catalog enables:
|
|
371
|
+
|
|
372
|
+
- AI agents to understand what rules exist and when they apply
|
|
373
|
+
- Tool authors to import rule definitions programmatically
|
|
374
|
+
- CI systems to configure which rules to enable/disable
|
|
375
|
+
- Documentation generators to stay in sync with the rule set
|
|
376
|
+
|
|
377
|
+
See the JSON file for the full schema.
|
|
378
|
+
|
|
379
|
+
---
|
|
380
|
+
|
|
381
|
+
## 4. Implementing This Specification
|
|
382
|
+
|
|
383
|
+
This specification is designed to be implementable by any tool. Here is how the pieces map to a typical linter architecture:
|
|
384
|
+
|
|
385
|
+
### Discovery
|
|
386
|
+
|
|
387
|
+
Scan for the project-level config files listed in [Section 1.3](#13-file-locations-by-client). Optionally scan global/user-level configs when the user opts in (these contain personal data and should not be scanned by default).
|
|
388
|
+
|
|
389
|
+
### Parsing
|
|
390
|
+
|
|
391
|
+
Parse JSON and normalize into a common structure regardless of which client's format the file uses. Key normalization steps:
|
|
392
|
+
|
|
393
|
+
1. Detect the client from the file path
|
|
394
|
+
2. Determine the expected root key (`servers` for VS Code, `mcpServers` for all others)
|
|
395
|
+
3. Infer transport type from fields: `command` present = stdio, `url` present = http/sse, explicit `type` field takes precedence
|
|
396
|
+
4. Extract server entries into a uniform shape
|
|
397
|
+
|
|
398
|
+
### Checking
|
|
399
|
+
|
|
400
|
+
Run per-file checks (schema, security, commands, deprecated, env, urls, redundancy) independently per config file. Run cross-file checks (consistency) after all files are parsed.
|
|
401
|
+
|
|
402
|
+
### Reporting
|
|
403
|
+
|
|
404
|
+
Rules use the `category/rule-id` naming convention (e.g., `mcp-security/hardcoded-bearer`). This maps cleanly to SARIF rule IDs for GitHub Code Scanning integration.
|
|
405
|
+
|
|
406
|
+
### Fixing
|
|
407
|
+
|
|
408
|
+
Rules marked as auto-fixable should apply surgical string replacements to the JSON file without reformatting the user's style (indentation, trailing commas, key ordering). Validate that the result is still valid JSON after applying fixes.
|
|
409
|
+
|
|
410
|
+
---
|
|
411
|
+
|
|
412
|
+
## 5. Contributing
|
|
413
|
+
|
|
414
|
+
This specification is maintained at [github.com/YawLabs/ctxlint](https://github.com/YawLabs/ctxlint).
|
|
415
|
+
|
|
416
|
+
To propose changes:
|
|
417
|
+
|
|
418
|
+
- **New rules:** Open an issue describing the rule, its severity, trigger condition, and which clients it applies to.
|
|
419
|
+
- **Client additions:** As new MCP clients emerge, submit a PR adding their config file location, root key, and any client-specific behaviors to Section 1.
|
|
420
|
+
- **Corrections:** If any client behavior documented here is inaccurate, open an issue with evidence (link to client docs, source code, or reproduction steps).
|
|
421
|
+
|
|
422
|
+
### Versioning
|
|
423
|
+
|
|
424
|
+
This specification follows semver:
|
|
425
|
+
|
|
426
|
+
- **Patch** (1.0.x): Typo fixes, clarifications, no rule changes
|
|
427
|
+
- **Minor** (1.x.0): New rules added, new clients documented
|
|
428
|
+
- **Major** (x.0.0): Rules removed or semantics changed in breaking ways
|
|
429
|
+
|
|
430
|
+
### Related specifications and tools
|
|
431
|
+
|
|
432
|
+
- [Model Context Protocol Specification](https://spec.modelcontextprotocol.io/) — the underlying protocol this config format serves
|
|
433
|
+
- [ctxlint](https://github.com/YawLabs/ctxlint) — reference implementation of this specification
|
|
434
|
+
- [mcp-compliance](https://github.com/YawLabs/mcp-compliance) — tests MCP server _behavior_ against the protocol spec (complementary to config linting)
|