Ghost MCP Server

🚀 幽靈安全MCP服務器

這是用於幽靈安全API的模型上下文協議（MCP）服務器，可通過標準化工具提供對安全檢測結果和倉庫數據的安全訪問。

✨ 主要特性

• 安全檢測結果管理：查詢、檢索和更新安全檢測結果。
• 倉庫分析：訪問倉庫數據及相關檢測結果。
• 通用MCP兼容性：可與任何兼容MCP的客戶端或應用程序配合使用。
• 內置CLI聊天機器人：包含一個簡單的聊天機器人，便於快速交互。
• 全面的API覆蓋：完全支持幽靈安全API（V2）端點。
• 類型安全：使用TypeScript完整實現，並具備正確的類型定義。
• 錯誤處理：擁有強大的錯誤處理和驗證機制。

📦 安裝指南

為Claude Code CLI快速安裝

選項1：交互式安裝程序（最簡單）

# 克隆並構建
git clone https://github.com/ghostsecurity/ghost-mcp-server
cd ghost-mcp-server
npm install && npm run build

# 運行交互式安裝程序（會提示輸入API密鑰）
npm run install:interactive

選項2：自動化設置腳本

# 克隆並構建
git clone https://github.com/ghostsecurity/ghost-mcp-server
cd ghost-mcp-server
npm install && npm run build

# 使用你的API密鑰運行設置腳本
./setup-claude-code.sh YOUR_API_KEY

# 可選：指定特定倉庫
./setup-claude-code.sh YOUR_API_KEY YOUR_REPO_ID

選項3：手動設置

# 克隆並構建
git clone https://github.com/ghostsecurity/ghost-mcp-server
cd ghost-mcp-server
npm install && npm run build

# 添加到Claude Code
claude mcp add --transport stdio --scope user ghost-security -- node $(pwd)/dist/index.js

# 然後編輯 ~/.claude.json 並在 mcpServers.ghost-security.env 下添加：
# {
#   "GHOST_SECURITY_API_KEY": "your-api-key",
#   "GHOST_SECURITY_BASE_URL": "https://api.ghostsecurity.ai/v2"
# }

選項4：從npm安裝（即將推出） 一旦發佈到npm，安裝將更加簡單：

claude mcp add --transport stdio --scope user ghost-security -- npx ghostsecurity-mcp

然後將你的API密鑰添加到 ~/.claude.json：

{
  "mcpServers": {
    "ghost-security": {
      "env": {
        "GHOST_SECURITY_API_KEY": "your-api-key-here",
        "GHOST_SECURITY_BASE_URL": "https://api.ghostsecurity.ai/v2"
      }
    }
  }
}

標準安裝（適用於所有MCP客戶端）

1. 克隆此倉庫：

git clone <repository-url>
cd ghost-mcp-server

2. 安裝依賴項：

npm install

3. 構建項目：

npm run build

💻 使用示例

配置

服務器在啟動時需要提供幽靈安全API密鑰，你可以通過以下兩種方式提供：

選項1：環境變量（推薦）

export GHOST_SECURITY_API_KEY="your-ghost-security-api-key"
export GHOST_SECURITY_BASE_URL="https://api.ghostsecurity.ai/v2"  # 可選，默認為v2
export GHOST_SECURITY_REPO_ID="your-repository-id"  # 可選 - 指定特定倉庫

選項2：命令行參數

node dist/index.js "your-ghost-security-api-key" "your-repository-id"

注意：倉庫ID是可選的。如果提供了倉庫ID，所有操作都將限定在該倉庫範圍內。

運行服務器

開發環境：

# 首先設置環境變量
export GHOST_SECURITY_API_KEY="your-api-key"
npm run dev

生產環境：

# 使用環境變量
export GHOST_SECURITY_API_KEY="your-api-key"
npm start

# 或者使用命令行參數
npm run build
node dist/index.js "your-api-key"

CLI聊天機器人

本項目包含一個由Anthropic的Claude API驅動的簡單CLI聊天機器人，可與MCP服務器進行交互。

export ANTHROPIC_API_KEY="your-anthropic-api-key"
export GHOST_SECURITY_API_KEY="your-ghost-api-key"
npm run chat

添加到任何MCP客戶端

此服務器遵循標準的MCP配置格式。以下是不同客戶端的配置示例：

標準MCP配置（Claude桌面版、ChatGPT等）

{
  "mcpServers": {
    "ghostsecurity": {
      "command": "node",
      "args": ["/path/to/ghost-mcp-server/dist/index.js"],
      "env": {
        "GHOST_SECURITY_API_KEY": "your-ghost-security-api-key",
        "GHOST_SECURITY_REPO_ID": "your-repository-id"
      }
    }
  }
}

環境變量設置（通用）

對於任何支持環境變量的MCP客戶端：

export GHOST_SECURITY_API_KEY="your-ghost-security-api-key"
export GHOST_SECURITY_BASE_URL="https://api.ghostsecurity.ai/v2"
export GHOST_SECURITY_REPO_ID="your-repository-id"

倉庫範圍設置

當通過 GHOST_SECURITY_REPO_ID 環境變量或CLI參數配置了倉庫ID時：

• ghostsecurity_get_findings 僅返回該倉庫的檢測結果。
• ghostsecurity_get_repositories 僅返回配置的倉庫。
• ghostsecurity_get_repository_findings 默認使用配置的倉庫（repoId參數可選）。

可用工具

安全檢測結果

ghostsecurity_get_findings

獲取安全檢測結果，支持可選的過濾和分頁。 參數：

• cursor（字符串，可選）：分頁遊標。
• sort（字符串，可選）：排序字段（created_at、updated_at）。
• order（字符串，可選）：排序順序（asc、desc）。
• size（數字，可選）：每頁大小（1 - 1000）。
• status（字符串，可選）：按狀態過濾。
• repo_id（字符串，可選）：按倉庫ID過濾。
• project_id（字符串，可選）：按項目ID過濾。

ghostsecurity_get_finding

通過ID獲取特定的安全檢測結果。 參數：

• id（字符串，必需）：檢測結果ID。
• repoId（字符串，必需）：與檢測結果關聯的倉庫ID。
• projectId（字符串，必需）：與檢測結果關聯的項目ID。

ghostsecurity_update_finding_status

更新安全檢測結果的狀態。 參數：

• id（字符串，必需）：檢測結果ID。
• repoId（字符串，必需）：與檢測結果關聯的倉庫ID。
• projectId（字符串，必需）：與檢測結果關聯的項目ID。
• status（字符串，必需）：檢測結果的新狀態。

倉庫

ghostsecurity_get_repositories

獲取倉庫列表，支持可選的過濾和分頁。 參數：

• cursor（字符串，可選）：分頁遊標。
• sort（字符串，可選）：排序字段（created_at、updated_at、last_committed_at）。
• order（字符串，可選）：排序順序（asc、desc）。
• size（數字，可選）：每頁大小（1 - 1000）。

ghostsecurity_get_repository

通過ID獲取特定的倉庫。 參數：

• id（字符串，必需）：倉庫ID。

ghostsecurity_get_repository_findings

獲取特定倉庫的安全檢測結果。 參數：

• repoId（字符串，可選*）：倉庫ID（*除非配置了 GHOST_SECURITY_REPO_ID，否則為必需參數）。
• cursor（字符串，可選）：分頁遊標。
• sort（字符串，可選）：排序字段（created_at、updated_at）。
• order（字符串，可選）：排序順序（asc、desc）。
• size（數字，可選）：每頁大小（1 - 1000）。

📚 詳細文檔

發佈到MCP註冊表

此服務器已配置為發佈到 MCP註冊表。

1. 安裝發佈者CLI：

brew install mcp-publisher

2. 登錄：

mcp-publisher login github

3. 發佈：

mcp-publisher publish

server.json 文件包含必要的元數據。在發佈到註冊表之前，請確保已將軟件包發佈到NPM。

開發

腳本

• npm run dev：以開發模式運行，支持熱重載。
• npm run build：將TypeScript編譯為JavaScript。
• npm start：運行已構建的服務器。
• npm run chat：運行CLI聊天機器人。

項目結構

src/
├── index.ts          # 主MCP服務器實現
├── ghost-client.ts   # 幽靈安全API客戶端（V2）
├── types.ts          # TypeScript類型定義
└── chatbot.ts        # CLI聊天機器人實現

API參考

此MCP服務器提供了幽靈安全API V2的完整接口。如需詳細的API文檔，請訪問： https://docs.ghostsecurity.ai/api-reference/introduction

📄 許可證

本項目採用MIT許可證。