使用说明
快速护卫员技能
AI编码代理的LLM安全性——保护应用程序免受快速注入、PII泄漏和数据泄露。使用 Cursor、Claude Code、Codex、Copilot、Gemini CLI、Windsurf、VSCode，以及任何MCP兼容代理。
安装MCP服务器
PromptGuard附带了内置于CLI中的本地MCP服务器。首先安装CLI，然后将MCP服务器添加到代理中。
先决条件
- PromptGuard命令行界面:
- macOS：
brew install promptguard/tap/promptguard - Linux/macOS：
curl -fsSL https://raw.githubusercontent.com/acebot712/promptguard-cli/main/install.sh | sh - 货物：
cargo install promptguard
- macOS：
- PromptGuard帐户 --注册地址： promptguard.co
- API密钥 --从以下位置获取一个 app.prompguard.co/设置/快捷键
按代理设置
Install in Cursor
一键安装 （打开Cursor并安装插件+MCP服务器）：
在游标中安装PromptGuard
或添加到 .cursor/mcp.json:
{
"mcpServers": {
"promptguard": {
"command": "promptguard",
"args": ["mcp", "-t", "stdio"]
}
}
}
Cursor还支持插件的规则、命令和代理——通过设置>插件>搜索“promptguard”进行安装。
Install in Claude Code
单线MCP安装 （最快——通过Claude CLI注册MCP服务器）：
claude mcp add promptguard -- promptguard mcp -t stdio
作为插件 （包括技能、代理和MCP服务器）：
claude --plugin-dir /path/to/promptguard-plugin
要提交到官方的Claude Code市场： claude.ai/设置/插件/提交
Install in VSCode / Copilot
添加到您的 .vscode/mcp.json:
{
"servers": {
"promptguard": {
"command": "promptguard",
"args": ["mcp", "-t", "stdio"]
}
}
}
Install in Windsurf
添加 ~/.codeium/windsurf/mcp_config.json:
{
"mcpServers": {
"promptguard": {
"command": "promptguard",
"args": ["mcp", "-t", "stdio"]
}
}
}
Install in Codex
作为插件 （包括技能和MCP服务器）：
复制到您的repo插件目录并在您的市场中注册：
cp -R /path/to/promptguard-plugin ./plugins/promptguard
添加 .agents/plugins/marketplace.json:
{
"name": "local-plugins",
"plugins": [{
"name": "promptguard",
"source": { "source": "local", "path": "./plugins/promptguard" },
"policy": { "installation": "AVAILABLE", "authentication": "ON_INSTALL" },
"category": "Security"
}]
}
或者在中单独添加MCP服务器 .codex/mcp.json:
{
"mcpServers": {
"promptguard": {
"command": "promptguard",
"args": ["mcp", "-t", "stdio"]
}
}
}
Install in Gemini CLI
添加 ~/.gemini/settings.json:
{
"mcpServers": {
"promptguard": {
"command": "promptguard",
"args": ["mcp", "-t", "stdio"]
}
}
}
Install in any other MCP client
通过stdio运行MCP服务器：
promptguard mcp -t stdio
配置MCP客户端以生成 promptguard mcp -t stdio 作为一个子流程。
MCP工具
连接后，代理可以直接调用这些工具：
| 工具 | 说明 |
|---|---|
promptguard_auth |
使用PromptGuard进行身份验证。打开仪表板以复制API密钥。 |
promptguard_logout |
删除本地存储的凭据。 |
promptguard_scan_text |
扫描文本，查看是否有快速注射、越狱、PII泄漏和毒性。 |
promptguard_scan_project |
扫描项目目录以查看未受保护的LLM SDK使用情况。 |
promptguard_redact |
从文本中修改PII（电子邮件、电话、SSN、信用卡、API密钥）。 |
promptguard_status |
显示当前配置、活动提供程序和密钥类型。 |
包含什么
除了MCP服务器，此仓库还包括代理技能和工作流程：
| 组件 | 描述 |
|---|---|
| 技能 | 安全的LLM集成 --逐步将PromptGuard添加到任何项目中。 PromptGuard API --教导代理扫描、编校和保护端点的确切请求/响应模式。 |
| 命令 | /promptguard-scan 查找未受保护的LLM调用和硬编码的秘密。 /promptguard-secure 将PromptGuard端到端添加到项目中。 |
| 代理 | LLM安全审查员——专门用于快速注入、PII泄漏、代理工具滥用和其他LLM特定漏洞的代码审查员。 |
| 规则 | 始终处于指导状态，确保代理在使用OpenAI、Anthropic或任何受支持的提供程序时编写安全的LLM代码。 |
这些组件在Cursor中本机工作（通过插件系统）。对于其他代理，技能和代理定义使用标准 SKILL.md 格式与Claude Code、Codex和任何读取markdown技能文件的代理兼容。
项目归属
要将MCP请求与特定的PromptGuard项目相关联（用于按项目计费和分析），请设置 project_id 在你当地 .promptguard.json:
{
"version": "1.0",
"api_key": "pg_live_xxx",
"project_id": "your-project-id",
"proxy_url": "https://api.promptguard.co/api/v1"
}
或者全局选择一个项目：
promptguard projects list
promptguard projects select <project-id>
支持的LLM提供商
OpenAI、Anthropic、Google Generative AI（Gemini）、Cohere、AWS Bedrock、LangChain、CrewAI、LlamaIdex、Vercel AI SDK。
