Skip to content

Document optional Armorer Guard MCP proxy #1137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
armorer-labs wants to merge 1 commit into
base: beta
Choose a base branch
from
Open

Document optional Armorer Guard MCP proxy #1137

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,32 @@ If auto-setup doesn't work, add this to your MCP client's config file:
}
```

**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"
]
}
}
}
```
Comment on lines +151 to +170
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

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 optional configuration uses [Armorer Guard](https://github.com/ArmorerLabs/Armorer-Guard)
as a local MCP proxy to inspect tool-call arguments for prompt injection,
credential leakage, exfiltration risk, and dangerous actions before forwarding
safe calls to Unity MCP.

**Windows:**
```json
{
Expand Down