MCP Auditor

English | 中文

一个用于审计与MCP（模型上下文协议）服务器所有交互的TypeScript工具。它通过透明代理的方式拦截并记录来自MCP服务器的所有I/O操作，生成全面的审计日志，帮助开发者调试、监控，并确保MCP应用的合规性。

快速链接

• 📚 完整文档
• 🌏 中文文档
• 🖥️ 服务器文档
• 📝 示例
• 📋 变更日志

功能

• ✅ 封装MCP服务器 - 作为客户端连接到现有的MCP服务器
• ✅ 暴露所有功能 - 暴露被封装服务器的所有工具、资源和提示
• ✅ 代理功能 - 透明地转发所有MCP操作
• ✅ 全面的日志记录 - 记录所有输入/输出交互（工具、资源、提示）
• ✅ 多种日志格式 - 结构化（详细）或JSON-RPC（协议消息）
• ✅ 标准IO传输 - 支持stdio通信的独立MCP服务器运行

快速开始

安装

作为库（推荐）：

npm install mcp-auditor

从源码安装：

git clone https://github.com/algovate/mcp-auditor.git
cd mcp-aauditor
npm install
npm run build

作为全局CLI：

npm install -g mcp-auditor

作为服务器运行

使用全局CLI（在执行npm install -g mcp-auditor之后）：

# 设置环境变量
export MCP_WRAPPED_SERVER_COMMAND=npx
export MCP_WRAPPED_SERVER_ARGS="-y,@modelcontextprotocol/server-filesystem,/tmp"
export MCP_LOG_FILE=./logs/mcp-server.log

# 运行服务器
mcp-auditor

使用配置文件：

# 创建config.json
cat > config.json << EOF
{
  "name": "mcp-auditor-server",
  "version": "1.0.0",
  "wrappedServer": {
    "serverCommand": "npx",
    "serverArgs": ["-y", "@modelcontextprotocol/server-filesystem", "/tmp"],
    "logFilePath": "./logs/mcp-server.log"
  }
}
EOF

# 使用配置运行
export MCP_CONFIG_FILE=./config.json
mcp-auditor

从源码运行：

# 配置环境变量
export MCP_WRAPPED_SERVER_COMMAND=npx
export MCP_WRAPPED_SERVER_ARGS="-y,@modelcontextprotocol/server-filesystem,/tmp"
export MCP_LOG_FILE=./logs/mcp-server.log

# 启动服务器
npm start

作为库使用

import { MCPWrapper } from 'mcp-auditor';

const wrapper = new MCPWrapper({
  serverCommand: 'npx',
  serverArgs: ['-y', '@modelcontextprotocol/server-filesystem', '/tmp'],
  logFilePath: './logs/mcp-wrapper.log'
});

await wrapper.connect();
const tools = wrapper.getTools();
const result = await wrapper.callTool('read_file', { path: '/tmp/example.txt' });
await wrapper.disconnect();

文档

对于详细的文档，请参阅：

• 英文文档
• 服务器模式文档
• 中文文档

项目结构

mcp-auditor/
├── src/
│   ├── core/              # 核心封装功能
│   │   ├── wrapper.ts     # 主MCPWrapper类
│   │   ├── logger.ts      # 日志实现
│   │   └── types.ts       # TypeScript类型
│   ├── server/            # 服务器特定代码
│   │   ├── server.ts      # MCP服务器实现
│   │   └── config.ts      # 配置加载器
│   └── index.ts           # 主入口点
├── examples/
│   ├── library/           # 库使用示例
│   └── server/            # 服务器使用示例
├── docs/                  # 文档
├── dist/                  # 编译输出
└── logs/                  # 日志文件

许可证

MIT

---

对于详细的使用说明、API文档和示例，请参阅完整文档。 </中文翻译>