@reinteractive/rails-insight 1.0.9 → 1.0.11
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 +6 -56
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# RailsInsight
|
|
1
|
+
# RailsInsight [Experimental Beta version]
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@reinteractive/rails-insight)
|
|
4
4
|
[](LICENSE)
|
|
@@ -11,43 +11,12 @@ Generic code-analysis tools treat Ruby files as plain text. RailsInsight underst
|
|
|
11
11
|
|
|
12
12
|
## Installation
|
|
13
13
|
|
|
14
|
-
|
|
15
|
-
npx @reinteractive/rails-insight
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
Or install globally:
|
|
14
|
+
First insall the package globally, which will install the MCP server locally, allowing your AI agents to run the indexing tooling.
|
|
19
15
|
|
|
20
16
|
```bash
|
|
21
17
|
npm install -g @reinteractive/rails-insight
|
|
22
18
|
```
|
|
23
19
|
|
|
24
|
-
## Quick Start
|
|
25
|
-
|
|
26
|
-
Run from your Rails project root:
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
npx @reinteractive/rails-insight
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
This starts a local MCP server over stdio. The indexer scans your project structure, extracts Rails conventions, builds a relationship graph, and exposes everything through MCP tools.
|
|
33
|
-
|
|
34
|
-
To point at a different Rails app:
|
|
35
|
-
|
|
36
|
-
```bash
|
|
37
|
-
npx @reinteractive/rails-insight --project-root /path/to/your/rails/app
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
### CLI Options
|
|
41
|
-
|
|
42
|
-
| Flag | Description |
|
|
43
|
-
| ----------------------- | ------------------------------------------------ |
|
|
44
|
-
| `--project-root <path>` | Path to the Rails project (defaults to cwd) |
|
|
45
|
-
| `--claude-md <path>` | Path to a `claude.md` / `CLAUDE.md` context file |
|
|
46
|
-
| `--mode local\|remote` | Transport mode (default: `local`) |
|
|
47
|
-
| `--port <number>` | Port for remote mode (default: `3000`) |
|
|
48
|
-
| `--verbose` | Enable verbose logging to stderr |
|
|
49
|
-
| `--help` | Show help |
|
|
50
|
-
|
|
51
20
|
## Claude Code Integration
|
|
52
21
|
|
|
53
22
|
Add to your Claude Code MCP configuration:
|
|
@@ -56,8 +25,8 @@ Add to your Claude Code MCP configuration:
|
|
|
56
25
|
{
|
|
57
26
|
"mcpServers": {
|
|
58
27
|
"railsinsight": {
|
|
59
|
-
"command": "
|
|
60
|
-
"args": ["-
|
|
28
|
+
"command": "node",
|
|
29
|
+
"args": ["/opt/homebrew/lib/node_modules/@reinteractive/rails-insight/bin/railsinsight.js", "-p", "."]
|
|
61
30
|
}
|
|
62
31
|
}
|
|
63
32
|
}
|
|
@@ -71,15 +40,13 @@ In your `.cursor/mcp.json`:
|
|
|
71
40
|
{
|
|
72
41
|
"mcpServers": {
|
|
73
42
|
"railsinsight": {
|
|
74
|
-
"command": "
|
|
75
|
-
"args": ["-
|
|
43
|
+
"command": "node",
|
|
44
|
+
"args": ["/opt/homebrew/lib/node_modules/@reinteractive/rails-insight/bin/railsinsight.js", "-p", "."]
|
|
76
45
|
}
|
|
77
46
|
}
|
|
78
47
|
}
|
|
79
48
|
```
|
|
80
49
|
|
|
81
|
-
The server uses the workspace directory as the project root automatically, so no path argument is needed for normal project-local use.
|
|
82
|
-
|
|
83
50
|
## VS Code Integration
|
|
84
51
|
|
|
85
52
|
In your VS Code `.mcp.json` file (or `.vscode/mcp.json`):
|
|
@@ -96,23 +63,6 @@ In your VS Code `.mcp.json` file (or `.vscode/mcp.json`):
|
|
|
96
63
|
}
|
|
97
64
|
```
|
|
98
65
|
|
|
99
|
-
First install globally:
|
|
100
|
-
|
|
101
|
-
```bash
|
|
102
|
-
npm install -g @reinteractive/rails-insight
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
Then update the path in `args` to match the output of:
|
|
106
|
-
|
|
107
|
-
```bash
|
|
108
|
-
npm root -g
|
|
109
|
-
# e.g. /opt/homebrew/lib/node_modules
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
> **Why not `npx`?** On macOS with Homebrew, VS Code may resolve `npx` to a different Node.js installation than your terminal (e.g. `/usr/local/bin/npx` vs `/opt/homebrew/bin/npx`). Using `node` with an explicit path to the globally installed script avoids this ambiguity.
|
|
113
|
-
|
|
114
|
-
Note: VS Code MCP configuration uses the `servers` block (not `mcpServers` as used by Claude Desktop/Cursor). The `"type": "stdio"` field is required.
|
|
115
|
-
|
|
116
66
|
## Available Tools
|
|
117
67
|
|
|
118
68
|
All 17 tools are available with no tier restrictions.
|