内容
# nr-mcp: New Relic MCP Server
MCP服务器允许AI代理查询New Relic以调试事件。
- [用户指南](#for-users): 如何将nr-mcp与您的AI助手一起使用
- [开发者指南](#for-developers): 如何为nr-mcp做贡献
- [文档](#documentation): 工具和资源的详细文档
---
# 用户指南
本节适用于希望将nr-mcp服务器与其AI助手一起使用的用户。
有关可用工具和资源的详细信息，请参见[文档](#documentation)部分。
## 先决条件
- 拥有New Relic账户，需具备：
- API密钥
- 账户ID
- 区域（美国或欧洲）
## 快速开始
要将AI助手连接到nr-mcp，请在您的MCP客户端设置中添加以下配置：
### Docker连接
```json
{
"mcpServers": {
"newrelic": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"NEW_RELIC_API_KEY",
"-e",
"NEW_RELIC_ACCOUNT_ID",
"-e",
"NEW_RELIC_REGION",
"danielng123/nr-mcp:latest"
],
"env": {
"NEW_RELIC_API_KEY": "<YOUR_API_KEY>",
"NEW_RELIC_ACCOUNT_ID": "<YOUR_ACCOUNT_ID>",
"NEW_RELIC_REGION": "US"
}
}
}
}
```
---
# 开发者指南
本节适用于希望为nr-mcp项目做贡献的开发者。
## 开发设置
```bash
# 克隆仓库
git clone https://github.com/ducduyn31/nr-mcp.git
cd nr-mcp
# 安装依赖
pnpm install
# 构建项目
pnpm build
```
MCP Inspector是一个强大的工具，用于调试和测试MCP服务器及客户端。
我们添加了一个简化的开发工作流程，自动监视文件更改，重建项目并运行检查器：
```bash
# 启动开发工作流程
pnpm dev
```
此命令：
1. 监视`src`目录中`.ts`文件的更改
2. 当检测到更改时自动重建项目
3. 并行运行MCP Inspector
### 手动测试
您也可以单独运行这些命令：
```bash
# 监视文件更改并重建
pnpm watch
# 启动检查器
pnpm inspector
```
### 使用检查器
检查器运行后：
1. 打开Web界面（通常在http://localhost:5173）
2. 选择“连接到服务器”
3. 选择“Stdio”作为传输类型
4. 输入启动服务器的命令：`node dist/index.js`
5. 点击“连接”
连接后，您可以：
- 浏览可用工具
- 使用自定义参数进行测试调用
- 查看响应和任何错误
- 记录和重放测试会话
### 调试提示
- 使用检查器比较预期响应与实际响应
- 监控每个工具调用的完整请求/响应周期
- 通过故意发送无效输入检查错误处理是否得当
- 验证您的工具是否遵循其声明的模式
## 开发
```bash
# 创建新工具
pnpm create-tool
# 代码检查
pnpm lint
# 格式化代码
pnpm format
```
## 许可证
MIT
---
# 文档
- [工具文档](docs/tools.md): 有关可用工具及其参数的详细信息
MCP 市场