rulesync 3.11.3 → 3.12.0
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/README.md +38 -3
- package/dist/index.cjs +326 -148
- package/dist/index.js +316 -138
- package/package.json +11 -10
package/README.md
CHANGED
|
@@ -60,7 +60,7 @@ Rulesync supports both **generation** and **import** for All of the major AI cod
|
|
|
60
60
|
| Tool | rules | ignore | mcp | commands | subagents |
|
|
61
61
|
|------------------------|:-----:|:------:|:-----:|:--------:|:---------:|
|
|
62
62
|
| AGENTS.md | ✅ | | | 🎮 | 🎮 |
|
|
63
|
-
| Claude Code | ✅ 🌏 | ✅ | ✅ 🌏 | ✅ 🌏 | ✅ 🌏 |
|
|
63
|
+
| Claude Code | ✅ 🌏 | ✅ | ✅ 🌏 📦 | ✅ 🌏 | ✅ 🌏 |
|
|
64
64
|
| Codex CLI | ✅ 🌏 | | 🌏 | 🌏 | 🎮 |
|
|
65
65
|
| Gemini CLI | ✅ 🌏 | ✅ | ✅ 🌏 | ✅ 🌏 | 🎮 |
|
|
66
66
|
| GitHub Copilot | ✅ | | ✅ | ✅ | 🎮 |
|
|
@@ -79,6 +79,7 @@ Rulesync supports both **generation** and **import** for All of the major AI cod
|
|
|
79
79
|
* ✅: Supports project mode
|
|
80
80
|
* 🌏: Supports global mode
|
|
81
81
|
* 🎮: Supports simulated commands/subagents (Project mode only)
|
|
82
|
+
* 📦: Supports modular MCP (Experimental)
|
|
82
83
|
|
|
83
84
|
## Why Rulesync?
|
|
84
85
|
|
|
@@ -148,7 +149,7 @@ Example:
|
|
|
148
149
|
// Basically, you can specify a `["."]` only.
|
|
149
150
|
// However, for example, if your project is a monorepo and you have to launch the AI agent at each package directory, you can specify multiple base directories.
|
|
150
151
|
"baseDirs": ["."],
|
|
151
|
-
|
|
152
|
+
|
|
152
153
|
// Delete existing files before generating
|
|
153
154
|
"delete": true,
|
|
154
155
|
|
|
@@ -158,7 +159,8 @@ Example:
|
|
|
158
159
|
// Advanced options
|
|
159
160
|
"global": false, // Generate for global(user scope) configuration files
|
|
160
161
|
"simulatedCommands": false, // Generate simulated commands
|
|
161
|
-
"simulatedSubagents": false // Generate simulated subagents
|
|
162
|
+
"simulatedSubagents": false, // Generate simulated subagents
|
|
163
|
+
"modularMcp": false // Enable modular-mcp for context compression (experimental, Claude Code only)
|
|
162
164
|
|
|
163
165
|
// Deprecated experimental options (for backward compatibility)
|
|
164
166
|
// "experimentalGlobal": false,
|
|
@@ -248,6 +250,7 @@ Example:
|
|
|
248
250
|
{
|
|
249
251
|
"mcpServers": {
|
|
250
252
|
"serena": {
|
|
253
|
+
"description": "Code analysis and semantic search MCP server",
|
|
251
254
|
"type": "stdio",
|
|
252
255
|
"command": "uvx",
|
|
253
256
|
"args": [
|
|
@@ -265,6 +268,7 @@ Example:
|
|
|
265
268
|
"env": {}
|
|
266
269
|
},
|
|
267
270
|
"context7": {
|
|
271
|
+
"description": "Library documentation search server",
|
|
268
272
|
"type": "stdio",
|
|
269
273
|
"command": "npx",
|
|
270
274
|
"args": [
|
|
@@ -277,6 +281,37 @@ Example:
|
|
|
277
281
|
}
|
|
278
282
|
```
|
|
279
283
|
|
|
284
|
+
#### Modular MCP Support (Experimental)
|
|
285
|
+
|
|
286
|
+
Rulesync supports [modular-mcp](https://github.com/d-kimuson/modular-mcp) for context compression. When enabled with `--modular-mcp`, it generates both `.mcp.json` and `modular-mcp.json` files for Claude Code.
|
|
287
|
+
|
|
288
|
+
**Benefits:**
|
|
289
|
+
- Reduces context usage by loading tool schemas on-demand
|
|
290
|
+
- Better scalability when using many MCP servers
|
|
291
|
+
- Improved performance with large tool collections
|
|
292
|
+
|
|
293
|
+
**Requirements:**
|
|
294
|
+
- Each MCP server must have a `description` field (required when `modularMcp` is enabled)
|
|
295
|
+
- Currently only supported for Claude Code
|
|
296
|
+
|
|
297
|
+
**Usage:**
|
|
298
|
+
|
|
299
|
+
```bash
|
|
300
|
+
# Enable modular-mcp via CLI
|
|
301
|
+
npx rulesync generate --targets claudecode --features mcp --modular-mcp
|
|
302
|
+
|
|
303
|
+
# Or via configuration file
|
|
304
|
+
{
|
|
305
|
+
"modularMcp": true
|
|
306
|
+
}
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
**Generated files:**
|
|
310
|
+
- `.mcp.json` - Contains modular-mcp proxy configuration
|
|
311
|
+
- `modular-mcp.json` - Contains actual MCP server configurations
|
|
312
|
+
|
|
313
|
+
For more information, see the [modular-mcp documentation](https://github.com/d-kimuson/modular-mcp).
|
|
314
|
+
|
|
280
315
|
### `.rulesyncignore`
|
|
281
316
|
|
|
282
317
|
Example:
|