Document optional Armorer Guard MCP proxy#1137
Open
armorer-labs wants to merge 1 commit into
Open
Conversation
Contributor
📝 WalkthroughWalkthroughThe README's Stdio configuration section is extended with optional documentation for macOS/Linux users. A JSON configuration example and description explain how to optionally route ChangesTool-Call Guard Configuration Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 151-170: Add a short prerequisite note above the JSON example
explaining that the "armorer-guard" executable must be installed and available
on PATH before using the mcpServers.unityMCP.command configuration; describe how
to install it (e.g., via the project's recommended installer or npm/yarn global
install) and/or provide the expected repository/package name and a brief
verification step (run `armorer-guard --version`) so users won't hit "command
not found" when using the shown configuration.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
Comment on lines
+151
to
+170
| **macOS/Linux with a local tool-call guard:** | ||
| ```json | ||
| { | ||
| "mcpServers": { | ||
| "unityMCP": { | ||
| "command": "armorer-guard", | ||
| "args": [ | ||
| "mcp-proxy", | ||
| "--", | ||
| "uvx", | ||
| "--from", | ||
| "mcpforunityserver", | ||
| "mcp-for-unity", | ||
| "--transport", | ||
| "stdio" | ||
| ] | ||
| } | ||
| } | ||
| } | ||
| ``` |
Contributor
There was a problem hiding this comment.
Add installation prerequisites for armorer-guard.
The configuration example assumes armorer-guard is already installed, but doesn't mention installation steps. Users copying this configuration will encounter "command not found" errors without prior setup.
📝 Suggested addition before the JSON example
**macOS/Linux with a local tool-call guard:**
+
+> [!NOTE]
+> Requires [Armorer Guard](https://github.com/ArmorerLabs/Armorer-Guard) to be installed first.
+> Install via: `pip install armorer-guard` or follow the [installation guide](https://github.com/ArmorerLabs/Armorer-Guard#installation).
+
```json🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@README.md` around lines 151 - 170, Add a short prerequisite note above the
JSON example explaining that the "armorer-guard" executable must be installed
and available on PATH before using the mcpServers.unityMCP.command
configuration; describe how to install it (e.g., via the project's recommended
installer or npm/yarn global install) and/or provide the expected
repository/package name and a brief verification step (run `armorer-guard
--version`) so users won't hit "command not found" when using the shown
configuration.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds an optional macOS/Linux stdio configuration showing how to wrap Unity MCP with
armorer-guard mcp-proxy -- ....This gives Unity MCP users a local pre-call guardrail for prompt injection, credential leakage, exfiltration risk, and dangerous actions before requests reach the Unity MCP server.
Summary by CodeRabbit