rails-informant 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51a0bd3a42b6c332ee192a319eaf43b8b129013995ac42d35a0de294a69c968f
-  data.tar.gz: 2eef05b3963d12586672b650cff43f5b999d8852ff229e42114f6b9cff0572a3
+  metadata.gz: b66bd1a6283f2a349a57994f529a0b57b71053c979c874268283d97477928873
+  data.tar.gz: d17e62d7ba21318f94205d9365d293ce1110fe58e9c56b4c82cc0c334e4f65bf
 SHA512:
-  metadata.gz: b9e51bc32c5393a1dced3621b661c72e8dcdf87d11a5d640c7addceb1ce9ec1526bc170519d0e71466503e2d589d53bdaec3b8063c21020d7fff3c6db5f12b82
-  data.tar.gz: 5eff7c322d4722b26d018dcf7a12e8f692e57e0f66374612e27271b41766a142cde8bb116dedbab1594f77aa6b1e28ec0e1b586929c69c39a9bd68b5f20cd2e3
+  metadata.gz: cf7f02ec548bbd755dc411b3f08a9a74807d45e333ccd3aedaf99b02be909ec4b4a046146ca913943dc41b88dc3e78cafcdf140163cdb1de2537c5d3f5a5b170
+  data.tar.gz: dd582dce1ccee4a3e6eaa3678c118416f9dff50afeafc00ad0a9a65a59e50760188541817f859d374f8aec5d139b5febb3024c54340b2b5fd98e36aa47fcfcf1

data/README.md

@@ -70,33 +70,28 @@ RailsInformant.capture(exception, context: { order_id: 42 })
 
 End-to-end path for AI agents (Claude Code, Devin) to start triaging errors:
 
-1. **Install the gem** -- follow [Quick Start](#quick-start) above
+1. **Install the gem** -- follow [Quick Start](#quick-start) above. The install generator creates `.mcp.json` automatically.
 2. **Set an authentication token** in your Rails credentials or env var:
    ```ruby
    # config/initializers/rails_informant.rb
    config.api_token = Rails.application.credentials.dig(:rails_informant, :api_token)
    ```
-3. **Add the MCP server** to your agent's config (see [MCP Server](#mcp-server) for full options):
-   ```json
-   {
-     "mcpServers": {
-       "informant": {
-         "command": "informant-mcp",
-         "env": {
-           "INFORMANT_PRODUCTION_URL": "https://myapp.com",
-           "INFORMANT_PRODUCTION_TOKEN": "your-api-token"
-         }
-       }
-     }
-   }
+3. **Set env vars** for the MCP server (e.g., via `.envrc` + [direnv](https://direnv.net)):
+   ```sh
+   # .envrc
+   export INFORMANT_PRODUCTION_URL=https://myapp.com
+   export INFORMANT_PRODUCTION_TOKEN=your-api-token
    ```
+   The MCP server process inherits environment variables from your shell, so `INFORMANT_*` vars set via `.envrc` (or any other method) are picked up automatically -- no need to inline them in `.mcp.json`.
 4. **Install the Claude Code skill** (optional but recommended):
    ```sh
    bin/rails generate rails_informant:skill
    ```
 5. **Use `/informant`** in Claude Code to triage and fix errors, or let Devin handle them autonomously with the [Devin integration](#devin-ai).
 
-> **Env var scoping:** `INFORMANT_API_TOKEN` configures the Rails app. `INFORMANT_PRODUCTION_URL` and `INFORMANT_PRODUCTION_TOKEN` configure the MCP server (agent side). They are different processes -- both need a token, but the MCP env vars point the agent at your running app.
+> **Connecting the tokens:** The `api_token` in your Rails credentials and `INFORMANT_PRODUCTION_TOKEN` must be the **same value**. The first authenticates incoming requests to your app; the second tells the MCP server what token to send.
+
+> **Secrets hygiene:** `.envrc` contains secrets and should be in `.gitignore`. `.mcp.json` is safe to commit -- it only contains the command name, no tokens.
 
 ## Configuration
 
@@ -153,23 +148,21 @@ The bundled `informant-mcp` executable connects Claude Code to your error data v
 
 ### Setup
 
-Add to your Claude Code MCP config:
+The install generator creates `.mcp.json` for you. To set it up manually:
 
 ```json
 {
   "mcpServers": {
     "informant": {
-      "command": "informant-mcp",
-      "env": {
-        "INFORMANT_PRODUCTION_URL": "https://myapp.com",
-        "INFORMANT_PRODUCTION_TOKEN": "your-api-token"
-      }
+      "command": "informant-mcp"
     }
   }
 }
 ```
 
-Or create `~/.config/informant-mcp.yml` for multi-environment setups:
+Set `INFORMANT_PRODUCTION_URL` and `INFORMANT_PRODUCTION_TOKEN` as environment variables (e.g., via `.envrc` + direnv). The MCP server inherits env vars from your shell -- no need to put secrets in `.mcp.json`.
+
+For multi-environment setups, create `~/.config/informant-mcp.yml`:
 
 ```yaml
 environments:
@@ -198,6 +191,23 @@ environments:
 | `get_informant_status` | Summary with counts and top errors |
 | `list_occurrences` | List occurrences with filtering |
 
+### Local Development
+
+The MCP server enforces HTTPS by default. When pointing at a local HTTP URL (e.g., `http://localhost:3000`), pass `--allow-insecure`:
+
+```json
+{
+  "mcpServers": {
+    "informant": {
+      "command": "informant-mcp",
+      "args": ["--allow-insecure"]
+    }
+  }
+}
+```
+
+This is only needed for local development/testing. Production setups over HTTPS don't need it.
+
 ## Claude Code Skill
 
 Use `/informant` in Claude Code to triage and fix errors interactively. The skill:

data/lib/generators/rails_informant/install_generator.rb

@@ -1,3 +1,4 @@
+require "json"
 require "rails/generators"
 require "rails/generators/active_record"
 
@@ -21,6 +22,22 @@ module RailsInformant
       route "mount RailsInformant::Engine => '/informant'"
     end
 
+    def create_or_update_mcp_json
+      mcp_path = File.join(destination_root, ".mcp.json")
+      informant_entry = { "command" => "informant-mcp" }
+
+      if File.exist?(mcp_path)
+        existing = JSON.parse(File.read(mcp_path))
+        existing["mcpServers"] ||= {}
+        existing["mcpServers"]["informant"] = informant_entry
+        create_file ".mcp.json", JSON.pretty_generate(existing) + "\n", force: true
+      else
+        create_file ".mcp.json", JSON.pretty_generate(
+          "mcpServers" => { "informant" => informant_entry }
+        ) + "\n"
+      end
+    end
+
     def print_next_steps
       say ""
       say "Rails Informant installed!", :green
@@ -34,18 +51,12 @@ module RailsInformant
       say "       # Add: rails_informant:"
       say "       #        api_token: #{SecureRandom.hex 32}"
       say ""
-      say "  3. Add the MCP server to .mcp.json (for Claude Code):"
-      say "       {"
-      say "         \"mcpServers\": {"
-      say "           \"informant\": {"
-      say "             \"command\": \"informant-mcp\","
-      say "             \"env\": {"
-      say "               \"INFORMANT_PRODUCTION_URL\": \"https://your-app.com\","
-      say "               \"INFORMANT_PRODUCTION_TOKEN\": \"your-api-token\""
-      say "             }"
-      say "           }"
-      say "         }"
-      say "       }"
+      say "  3. Configure env vars for the MCP server (e.g., via .envrc + direnv):"
+      say "       export INFORMANT_PRODUCTION_URL=https://your-app.com"
+      say "       export INFORMANT_PRODUCTION_TOKEN=your-api-token"
+      say ""
+      say "     The token must match the api_token in your Rails credentials."
+      say "     Add .envrc to .gitignore — it contains secrets."
       say ""
       say "  4. Optional — install the Claude Code skill:"
       say "       bin/rails generate rails_informant:skill"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-informant
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Daniel López Prat