Newrelic MCP

🚀 New Relic MCP Server

New Relic MCP Server 是一個遵循模型上下文協議（MCP）的服務器，可與 New Relic 的可觀測性平臺實現無縫集成。你可以通過這個簡單統一的接口查詢指標、管理警報、監控應用程序，並與整個可觀測性堆棧進行交互。

免責聲明：這是一個非官方的社區項目，與 New Relic, Inc. 沒有關聯、未得到其認可或支持。所有商標均為其各自所有者的財產。

🚀 快速開始

按照以下步驟，你可以快速安裝並使用 New Relic MCP Server：

1. 安裝並配置 New Relic MCP Server。
2. 獲取 New Relic 憑證。
3. 通過 MCP 客戶端與 New Relic 進行交互。

✨ 主要特性

• 📊 NRQL 查詢 - 執行強大的查詢以分析數據。
• 🚀 APM 集成 - 監控應用程序的性能和健康狀況。
• 🔔 警報管理 - 查看並確認警報和事件。
• 🔍 實體搜索 - 在整個基礎設施中發現並檢查實體。
• 📈 合成監控 - 管理合成監控器和檢查。
• 🔧 NerdGraph API - 直接訪問 New Relic 的 GraphQL API。
• 🌐 REST v2 工具（2.0+） - 提供用於部署、APM 應用程序、指標和警報的高價值 REST 端點。

📦 安裝指南

使用 Smithery 快速安裝

若要通過 Smithery 進行安裝或部署，請參閱官方文檔：部署、項目配置 和 smithery.yaml 參考。

若要通過 Smithery 為 Claude Desktop 自動安裝 New Relic MCP，請執行以下命令：

npx @smithery/cli install newrelic-mcp --client claude

Smithery CLI（推薦）

我們推薦使用 Smithery CLI 進行本地開發、檢查和部署。其優勢如下：

• 統一的開發/構建/部署工作流程，與客戶端無關。
• 帶有熱重載和 playground 的開發服務器（可選隧道）。
• 為 stdio 或 shttp 傳輸構建捆綁包。
• 交互式檢查服務器；使用提供的配置運行。
• 為每個客戶端簡單安裝。

示例：

# 熱重載開發服務器
npx @smithery/cli dev src/server.ts --port 8181 --no-open

# 構建生產捆綁包（shttp 傳輸）
npx @smithery/cli build src/server.ts --out .smithery/index.cjs --transport shttp

# 檢查已發佈的服務器
npx @smithery/cli inspect @cloudbring/newrelic-mcp

# 使用配置運行（通過 JSON 傳遞環境變量）
npx @smithery/cli run @cloudbring/newrelic-mcp --config '{"NEW_RELIC_API_KEY":"...","NEW_RELIC_ACCOUNT_ID":"..."}'

# 安裝到特定客戶端
npx @smithery/cli install newrelic-mcp --client claude

# 打開 playground
npx @smithery/cli playground --port 3001

手動安裝

{
  "mcpServers": {
    "newrelic": {
      "command": "npx",
      "args": [
        "-y",
        "newrelic-mcp"
      ],
      "env": {
        "NEW_RELIC_API_KEY": "your-api-key-here",
        "NEW_RELIC_ACCOUNT_ID": "your-account-id"
      }
    }
  }
}

🔧 配置說明

必需的環境變量

• NEW_RELIC_API_KEY - 你的 New Relic 用戶 API 密鑰（必需）。
• NEW_RELIC_ACCOUNT_ID - 你的 New Relic 賬戶 ID（可選，可在每個工具調用時提供）。

獲取 New Relic 憑證

1. API 密鑰：
   • 登錄 New Relic。
   • 在左側邊欄中導航到 API 密鑰。
   • 創建一個具有適當權限的新用戶 API 密鑰。
2. 賬戶 ID：
   • 登錄 New Relic 時，在 URL 中找到你的賬戶 ID。
   • 或者導航到 管理 → 訪問管理 → 賬戶。

有關詳細的設置說明，請參閱 docs/new-relic-setup.md。

💻 使用示例

基礎用法

配置完成後，你可以通過 MCP 客戶端與 New Relic 進行交互：

查詢數據

"Show me the average response time for my web application over the last hour"
"What are the top 10 slowest database queries today?"
"Display error rate trends for the production environment"

監控應用程序

"List all my APM applications and their current status"
"Show me the health of my Node.js services"
"Which applications have active alerts?"

管理警報

"Show me all open incidents"
"What critical alerts fired in the last 24 hours?"
"Acknowledge incident #12345"

搜索基礎設施

"Find all Redis databases in production"
"Show me entities with high CPU usage"
"List all synthetic monitors and their success rates"

📚 詳細文檔

工具參考

以下是此服務器公開的所有 MCP 工具的簡明目錄。詳細的故事/規範請參閱 docs 文件夾。

NerdGraph/GraphQL 工具

REST v2 工具（v2.0 新增）

參考資料：

• 詳細規範和模式：docs/REST_ENDPOINT_TOOL.md 和 docs/rest-tools-stories/*

故障排除

開發說明

項目結構

src/
├── server.ts           # 主 MCP 服務器實現
├── client/
│   └── newrelic-client.ts  # New Relic API 客戶端
└── tools/
    ├── nrql.ts         # NRQL 查詢工具
    ├── apm.ts          # APM 應用程序工具
    ├── entity.ts       # 實體管理工具
    ├── alert.ts        # 警報和事件工具
    ├── synthetics.ts   # 合成監控工具
    └── nerdgraph.ts    # NerdGraph 查詢工具

設置開發環境

1. 克隆倉庫：

git clone https://github.com/cloudbring/newrelic-mcp.git
cd newrelic-mcp

2. 安裝依賴：

npm install

3. 創建一個 .env 文件：

NEW_RELIC_API_KEY=your-api-key-here
NEW_RELIC_ACCOUNT_ID=your-account-id

4. 構建項目：

npm run build

開發命令

# 啟動帶有熱重載的開發服務器
npm run dev

# 構建生產版本
npm run build

# 運行測試
npm test

# 運行帶覆蓋率的測試
npm run test:coverage

# 運行 linting
npm run lint

# 格式化代碼
npm run format

# 測試服務器啟動
npm run test:server

測試

該項目使用測試驅動開發（TDD），並結合以下工具：

• Vitest 進行單元測試。
• Gherkin 進行 BDD 測試。
• Evalite 進行 LLM 響應驗證。

# 運行所有測試
npm test

# 運行帶覆蓋率的測試
npm run test:coverage

# 僅運行 BDD 測試
npm run test:bdd

# 使用真實 API 運行集成測試
USE_REAL_ENV=true npm test

調試

使用 MCP Inspector 測試和調試服務器：

# 使用 MCP Inspector 運行
npm run inspect

# 使用開發服務器運行
npm run inspect:dev

# 使用環境變量運行
npm run inspect:env

有關詳細說明，請參閱 docs/mcp-inspector-setup.md。

架構

服務器採用模塊化架構，包括：

• 客戶端層：處理與 New Relic API 的通信。
• 工具層：實現 MCP 工具規範。
• 服務器層：管理 MCP 協議和工具路由。

每個工具：

• 具有單一、明確的目的。
• 使用 Zod 模式驗證輸入。
• 返回結構化、類型化的響應。
• 包括全面的錯誤處理。

貢獻指南

我們歡迎貢獻！詳細信息請參閱我們的 貢獻指南。

開發工作流程

1. 分叉倉庫。
2. 創建一個功能分支（git checkout -b feature/amazing-feature）。
3. 首先編寫測試（TDD 方法）。
4. 實現你的功能。
5. 確保所有測試通過（npm test）。
6. 保持代碼覆蓋率 >90%。
7. 運行 linting（npm run lint）。
8. 提交你的更改（提交將自動格式化）。
9. 推送到你的分支。
10. 打開一個拉取請求。

代碼風格

本項目使用：

• Biome 進行 linting 和格式化。
• TypeScript 並啟用嚴格模式。
• 2 個空格 進行縮進。
• 單引號 用於字符串。
• 分號 始終使用。

文檔資料

• New Relic 設置指南 - 詳細的憑證設置。
• MCP Inspector 設置 - 測試和調試。
• 日誌記錄與遙測 - 測試監控。
• 實現細節 - 架構深入分析。
• REST 工具概述 - REST v2 工具的高級設計。
• REST 工具故事 - 每個工具的規範、模式和測試計劃。

對比情況

我們研究了其他公開的 New Relic MCP 服務器，在撰寫本文時，未發現任何積極維護、功能完整的替代方案。如果你知道有這樣的項目，請打開一個問題將其添加到此處。

計劃的增強功能（基於 REST v2 目錄和用戶需求）：

• 警報：在可用的情況下，通過 REST 管理違規和條件。
• 指標：提供更廣泛的應用程序級指標端點（名稱/數據），而不僅僅是每個主機的指標。
• 額外的 REST 覆蓋：標籤、關鍵事務、移動應用程序（根據反饋進行優先級排序）。

支持與反饋

• 🐛 報告錯誤
• 💡 請求功能
• 💬 參與討論
• 📖 閱讀文檔

📄 許可證

本項目採用 MIT 許可證 - 有關詳細信息，請參閱 LICENSE 文件。

免責聲明

本項目與 New Relic, Inc. 沒有關聯、未得到其認可或支持。它是一個獨立的開源項目，使用了 New Relic 的公共 API。

致謝

• 基於 模型上下文協議 規範構建。
• 與 New Relic 的可觀測性平臺 API 集成。
• 受更廣泛的 MCP 生態系統啟發。

由 @cloudbring 使用 Cursor 和 Claude Code 用心打造 ❤️