Assert

@assert-click/mcp

Assert の MCP サーバーです。AI コーディングエージェントがチャットを離れずに、E2E テストを生成、実行、確認できます。

ユーザーフローを平易な英語で説明してください。Assert は Playwright テストを生成し、実際のブラウザーで実行して、ステップごとの結果と失敗時のスクリーンショットを返します。これらすべてを、Cursor、Claude、Windsurf、または MCP 互換エージェントでツールを1回呼び出すだけで行えます。

このパッケージを使用する前に、**assert.click で無料登録**して、API キーとプロジェクト ID を取得してください。

エージェントでできること

• 生成 — フローを説明すると、保存して実行できる Markdown シナリオが返されます
• 実行 — 保存済みシナリオまたはその場で指定した Markdown を、実際の Chromium ブラウザーで実行します
• 確認 — ステップごとの成功／失敗、エラーメッセージ、失敗時のスクリーンショット URL を取得します
• 一覧表示 — API キーで参照できる保存済みシナリオを一覧表示します

必要条件

• Node.js >=18.17
• プロジェクトスコープの Assert キー — assert.click で取得してください

セットアップ

1. リポジトリに assert.config.json を作成します：

{
  "projectApiKey": "assert_project_key_here",
  "projectId": "project_123"
}

2. エージェントの設定に MCP サーバーを追加します：

{
  "mcpServers": {
    "assert": {
      "command": "npx",
      "args": ["-y", "@assert-click/mcp"],
      "env": {
        "ASSERT_CONFIG": "/absolute/path/to/assert.config.json"
      }
    }
  }
}

これで完了です。エージェントが Assert の4つのツールをすべて利用できるようになります。

プライベート URL

localhost、127.0.0.1、LAN または VPN の IP アドレスなどの対象は、デフォルトでブロックされています。

Assert の実行を行うマシンで、次の設定によってプライベートな対象を許可するよう意図的に構成していない限り、公開 URL を使用してください：

ALLOW_PRIVATE_TARGETS=true

この設定は、Assert を実行するマシンまたはプロセスに指定してください。assert.config.json には記述しないでください。

環境変数

• ASSERT_API_KEY：API キー（assert.config.json に保存する代わりに使用できます）
• ASSERT_PROJECT_ID：省略可能なデフォルトのプロジェクト ID
• ASSERT_CONFIG：省略可能な設定ファイルまたはディレクトリへのパス

設定ファイル

MCP サーバーは、現在のディレクトリから上位へ向かって、次のファイルを検索します：

• assert.config.json
• assert.config.local.json

assert.config.local.json は assert.config.json に上書きマージされます。

キーをコミットせず、環境変数でシークレットを管理する場合は、次のようにします：

{
  "projectApiKeyEnv": "ASSERT_API_KEY",
  "projectId": "project_123"
}

ツール

assert_generate

平易な英語での説明から Markdown シナリオを生成します。

入力：

• description: string — ユーザーができるようにすること
• url: string — 開始 URL
• project_id?: string
• save?: boolean — プロジェクトに保存するかどうか（デフォルト：false）

戻り値：

{
  "scenario_id": "scenario_123",
  "markdown": "URL: https://example.com/login\nSCENARIO: Login\nPROCESS:\n  - Fill \"email\" with \"[email protected]\"\nEXPECT: Dashboard",
  "saved": true
}

assert_run

保存済みシナリオまたはその場で指定した Markdown を、実際のブラウザーで実行します。

入力：

• scenario_id?: string
• markdown?: string
• project_id?: string
• request_id?: string

scenario_id または markdown のいずれか一方を必ず指定してください。

戻り値：

{
  "run_id": "run_123",
  "status": "queued",
  "estimated_duration_seconds": null
}

assert_status

実行のステップごとの結果を取得します。

入力：

• run_id: string

戻り値：

{
  "run_id": "run_123",
  "status": "passed",
  "duration_ms": 4200,
  "steps": [
    {
      "description": "Fill email",
      "status": "passed",
      "error": null,
      "screenshot_url": null
    }
  ],
  "failure_summary": null,
  "full_log_url": null
}

assert_list

API キーで参照できる保存済みシナリオを一覧表示します。

入力：

• project_id?: string
• cursor?: string
• limit?: number

project_id は現在、将来的なフィルタリング機能のために予約されています。現在の API では、API キーで参照できるすべてのシナリオが一覧表示されます。

戻り値：

{
  "scenarios": [
    {
      "id": "scenario_123",
      "name": "Login flow",
      "project_id": null,
      "last_run_status": "passed",
      "last_run_at": "2026-03-31T10:00:00.000Z",
      "url": "https://example.com/login"
    }
  ],
  "next_cursor": null
}

エラー

エラーは構造化 JSON として返されます：

{
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The ASSERT_API_KEY is invalid or missing.",
    "field": null
  }
}

一般的なコード：

• INVALID_API_KEY
• SCENARIO_NOT_FOUND
• RUN_NOT_FOUND
• VALIDATION_ERROR
• UPSTREAM_ERROR

ライセンス

MIT