Ghost MCP Server

🚀 Ghost Security MCP Server

Ghost Security APIのモデルコンテキストプロトコル（MCP）サーバーで、標準化されたツールを通じてセキュリティ調査結果とリポジトリデータへの安全なアクセスを提供します。

🚀 クイックスタート

Ghost Security MCP Serverは、Ghost Security APIに対応したMCPサーバーで、セキュリティ調査結果やリポジトリデータに安全にアクセスできます。以下に、インストール方法と使用方法を説明します。

✨ 主な機能

• セキュリティ調査結果の管理：セキュリティ調査結果のクエリ、取得、更新ができます。
• リポジトリ分析：リポジトリデータと関連する調査結果にアクセスできます。
• Universal MCP互換性：任意のMCP互換クライアントまたはアプリケーションと連携可能です。
• CLIチャットボット付属：簡単なチャットボットが含まれており、迅速な対話が可能です。
• 包括的なAPIカバレッジ：Ghost Security 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

💻 使用例

設定

サーバーの起動時には、Ghost Security APIキーを提供する必要があります。以下の2つの方法で提供できます。

オプション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はオプションです。指定した場合、すべての操作はそのリポジトリにスコープされます。

サーバーの起動

開発用:

# まず環境変数を設定します。
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 Desktop、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   # Ghost Security APIクライアント (V2)
├── types.ts          # TypeScriptの型定義
└── chatbot.ts        # CLIチャットボットの実装

APIリファレンス

このMCPサーバーは、Ghost Security API V2への完全なインターフェイスを提供します。詳細なAPIドキュメントについては、以下を参照してください。 https://docs.ghostsecurity.ai/api-reference/introduction

📄 ライセンス

MIT