bugAgent MCP Server

官方

将bugAgent连接到任何兼容MCP的AI客户端。直接从AI编码助手中提交、分类和管理缺陷、功能请求等。无需切换上下文，无需复制粘贴——只需描述问题，bugAgent会处理其余部分。

访问 bugagent.com

文档

MCP v1

导航

模型上下文协议

MCP

将 bug_Agent_ 连接到任何兼容 MCP 的 AI 客户端。

直接从您的 AI 编码助手中提交、分类和管理错误、功能请求等。无需切换上下文，无需复制粘贴——只需描述问题，bug_Agent_ 会处理其余部分。

Discord 社区 [email protected]

入门指南

bug_Agent_ MCP 服务器允许 AI 客户端通过模型上下文协议创建、查询和管理错误报告、功能请求、增强功能等。它在本地运行，并与 bug_Agent_ 的云 API 通信。

1

获取您的 API 密钥

在 app.bugagent.com 注册，并从控制台生成一个 API 密钥。

2

配置您的 AI 客户端

在客户端的配置中将 bug_Agent_ 添加为 MCP 服务器（请参阅下面的设置）。

3

开始提交错误

用自然语言描述一个错误，bug_Agent_ 会自动分类、丰富信息并存储它。

快速示例

# Create a bug report
"File a bug: Login button is unresponsive on iOS Safari.
Steps: tap login, nothing happens. Expected: navigate to
dashboard. Severity: high."

# bugAgent auto-classifies as UI bug, severity high

# File a feature request
"Feature request: Add dark mode toggle to the
settings page. Users have asked for this in surveys."

# Auto-classified as feature-request, severity medium

设置

安装

无需全局安装。使用 npx 按需运行 MCP 服务器：

npx @bugagent/mcp-server

配置您的 API 密钥

首次连接时，bug_Agent_ 会提示您输入 API 密钥。您也可以通过环境变量设置它：

export BUGAGENT_API_KEY=ba_live_your_key_here

从 bug_Agent_ 控制台获取您的 API 密钥。

MCP 客户端配置

将以下内容添加到您的 MCP 客户端配置文件中：

mcp.json

{
  "mcpServers": {
    "bugagent": {
      "command": "npx",
      "args": ["-y", "@bugagent/mcp-server"],
      "env": {
        "BUGAGENT_API_KEY": "ba_live_your_key_here"
      }
    }
  }
}

💡

将 ba_live_your_key_here 替换为您从控制台获取的实际 API 密钥。

连接到服务器

bug_Agent_ MCP 服务器通过可流式 HTTP 传输在 https://mcp.bugagent.com/mcp 上运行。从以下八个客户端中的任意一个连接——选择适合您工作流程的那个。

🔑

首先获取您的 API 密钥。 登录 app.bugagent.com/dashboard/settings/api-keys，点击 创建 API 密钥，并复制该值（以 ba_live_ 开头）。您只会看到它一次，因此请将其粘贴到安全的地方。下面的每个示例都使用此密钥。

选项 1 — MCP Inspector（Web 界面，推荐用于首次测试）

Anthropic 官方工具。启动一个本地 Web 界面，您可以在其中点击每个工具、填写参数并查看响应。零配置，无需 IDE。

macOS（终端）

终端

npx @modelcontextprotocol/inspector

Windows（PowerShell 或 CMD）

PowerShell

在打开的浏览器界面中：

  1. 传输类型：选择 Streamable HTTP
  2. URL：https://mcp.bugagent.com/mcp
  3. 连接类型：选择 代理（默认——Inspector 通过本地 Node 进程代理以绕过浏览器 CORS）
  4. 点击 认证 选项卡 → 添加自定义标头：
    • 标头名称：Authorization
    • 值：Bearer ba_live_YOUR_KEY_HERE
  5. 点击 连接。您将在左侧面板中看到所有 60 多个 bug_Agent_ 工具。
  6. 点击任何工具（例如 list_bug_reports），填写参数，点击 运行工具。响应显示在右侧。

先决条件：Node.js 18 或更高版本。如果没有，请从 nodejs.org 安装。

选项 2 — Claude Desktop（Mac + Windows）

如果您使用 Claude Desktop 应用程序，可以将 bug_Agent_ 添加为永久 MCP 服务器。然后，Claude 将在每次对话中提供所有 bug_Agent_ 工具。

macOS

  1. 打开 Claude Desktop → 菜单栏 Claude → 设置 → 开发者 → 编辑配置。这将打开 ~/Library/Application Support/Claude/claude_desktop_config.json。
  2. 在 mcpServers 下添加 bug_Agent_ 条目：
    claude_desktop_config.json
{  
  "mcpServers": {  
    "bugagent": {  
      "type": "http",  
      "url": "https://mcp.bugagent.com/mcp",  
      "headers": {  
        "Authorization": "Bearer ba_live_YOUR_KEY_HERE"  
      }  
    }  
  }  
}
  1. 保存文件并完全退出 Claude Desktop（Cmd+Q，而不仅仅是关闭窗口）。
  2. 重新启动 Claude Desktop。聊天输入框底部的工具锤图标现在应显示 bug_Agent_ 工具。
  3. 试试看：输入 “列出我最近的 5 个错误报告” —— Claude 将自动调用 list_bug_reports。

Windows

  1. 打开 Claude Desktop → 文件 → 设置 → 开发者 → 编辑配置。这将打开 %APPDATA%\Claude\claude_desktop_config.json（通常是 C:\Users\YourName\AppData\Roaming\Claude\claude_desktop_config.json）。
  2. 添加与 macOS 部分相同的 JSON 块。
  3. 保存文件并从系统托盘中完全退出 Claude Desktop（右键单击 Claude 图标 → 退出），然后重新启动。
  4. 工具锤图标将显示 bug_Agent_ 工具。

选项 3 — Claude Code（CLI）

如果您从终端使用 Claude Code（CLI 版本的 Claude），请使用一个命令注册 bug_Agent_ 服务器。在 macOS、Linux 和 Windows 上操作相同。

终端 / PowerShell

claude mcp add --transport http bugagent https://mcp.bugagent.com/mcp \
  --header "Authorization: Bearer ba_live_YOUR_KEY_HERE"

然后重新启动您的 Claude Code 会话。验证它是否已连接：

claude mcp list

您应该会在列表中看到带有绿点的 bugagent。在任何聊天中开始使用工具：“显示我本月的探索使用情况。”

稍后要移除它：

claude mcp remove bugagent

选项 4 — OpenAI Codex CLI

如果您使用 OpenAI Codex CLI，请将 bug_Agent_ 添加到 ~/.codex/config.toml 以进行永久注册，或者为一次性会话内联传递配置。

永久注册（添加到配置）

~/.codex/config.toml

[[mcp_servers]]
name = "bugagent"
type = "http"
url  = "https://mcp.bugagent.com/mcp"

[mcp_servers.headers]
Authorization = "Bearer ba_live_YOUR_KEY_HERE"

内联 — 单次会话

终端

codex \
  --mcp-server '{"name":"bugagent","type":"http","url":"https://mcp.bugagent.com/mcp","headers":{"Authorization":"Bearer ba_live_YOUR_KEY_HERE"}}' \
  "list the last 5 bug reports"

Codex 会根据您的自然语言提示自动解析工具调用。试试：“列出我按严重性排序的未解决错误。”

选项 5 — Cursor（Mac + Windows）

Cursor 内置了 MCP 支持。添加一次 bug_Agent_，Cursor 中的 AI 助手就可以在不离开编辑器的情况下提交错误、列出报告、运行扫描等。

  1. 打开 Cursor → 设置（Mac 上为 Cmd+, / Windows 上为 Ctrl+,）→ 左侧边栏中的 MCP。
  2. 点击 + 添加新的 MCP 服务器。
  3. 选择 HTTP 传输类型。
  4. 填写：
    • 名称：bugagent
    • URL：https://mcp.bugagent.com/mcp
    • 标头名称：Authorization
    • 标头值：Bearer ba_live_YOUR_KEY_HERE
  5. 点击 保存。连接后，Cursor 会显示一个绿色指示器。
  6. 打开 Cursor 的聊天（Cmd+L / Ctrl+L）并输入 “创建一个标题为‘登录中断’且严重性为高的错误报告。” Cursor 将调用 create_bug_report。

替代方案：Cursor 也会读取 ~/.cursor/mcp.json（Mac）或 %USERPROFILE%\.cursor\mcp.json（Windows）。添加与 Claude Desktop 部分相同的 JSON 格式。

选项 6 — 带有 Continue 扩展的 VS Code（Mac + Windows）

如果您更喜欢 VS Code，Continue 扩展原生支持 MCP 服务器。

  1. 从 VS Code 市场安装 Continue 扩展。
  2. 打开 Continue 的配置：命令面板（Cmd+Shift+P / Ctrl+Shift+P）→ Continue: 打开 config.json。文件位于：
    • macOS：~/.continue/config.json
    • Windows：%USERPROFILE%\.continue\config.json
  3. 添加一个 mcpServers 条目：
    ~/.continue/config.json
{  
  "mcpServers": [  
    {  
      "name": "bugagent",  
      "type": "streamable-http",  
      "url": "https://mcp.bugagent.com/mcp",  
      "requestOptions": {  
        "headers": {  
          "Authorization": "Bearer ba_live_YOUR_KEY_HERE"  
        }  
      }  
    }  
  ]  
}
  1. 保存。Continue 将自动重新加载并在侧边栏中显示 bug_Agent_ 工具。
  2. 打开 Continue 聊天面板并尝试：“列出我的安全扫描。”

其他支持 MCP 的 VS Code 扩展：Cline、Roo Code 和 Windsurf（分支）都遵循类似的 JSON 配置模式，带有 mcpServers 键和 HTTP 传输。

选项 7 — 支持 OAuth 的主机（以 Claude.ai 网页版为例）

一些 MCP 主机通过 OAuth 2.0 进行身份验证，并要求预先提供静态的 client_id 和 client_secret，而不是接受 Bearer API 密钥。对于这些主机，您可以从 bug_Agent_ 仪表板生成一个工作区范围的 OAuth 凭据对，并将其粘贴到主机的连接器表单中。这些凭据与 MCP 主机无关——任何支持授权码 + PKCE 的 OAuth 客户端都可以使用它们。下面的演练使用 Claude.ai 网页应用程序作为最常见的示例。

  1. 在 bug_Agent_ 中：打开 设置 → 开发者 → MCP 连接器。点击 生成连接器，为其命名以描述主机（例如 “Claude.ai（工作）”），粘贴您的 MCP 主机所需的回调 URI（对于 Claude.ai 网页应用程序，即 https://claude.ai/api/mcp/auth_callback —— 对于其他主机，请查阅其连接器文档），并为身份验证方法选择 机密。复制成功屏幕上显示一次的 client_id 和 client_secret。
  2. 在您的 MCP 主机的连接器 / OAuth 设置中，粘贴：
    • 服务器 URL：https://mcp.bugagent.com/mcp
    • 客户端 ID + 客户端密钥：来自步骤 1
    • 授权 URL：https://mcp.bugagent.com/authorize
    • 令牌 URL：https://mcp.bugagent.com/token
      对于 Claude.ai 具体来说：前往 claude.ai/customize/connectors 并点击 添加 MCP 连接器。
  3. 保存。主机会将您重定向到 bug_Agent_ 以登录（Google 或电子邮件/密码——无论您使用哪种方法登录仪表板）并批准同意，然后完成 OAuth 握手。
  4. 从同一设置页面管理和撤销已生成的连接器。撤销是即时的——来自该连接器的下一个请求将返回 invalid_client。

注意： Claude Code、Cursor、VS Code 和 MCP Inspector 不需要此流程——它们会自动处理动态客户端注册（RFC 7591），并通过如上所示的 API 密钥进行身份验证。MCP 连接器表单仅适用于需要静态 OAuth 凭据的主机。

选项 8 — 使用 curl 的直接 HTTP（终端）

如果您想在没有客户端的情况下直接测试服务器，或将其集成到脚本中，可以使用 curl 访问 HTTP 端点。MCP 协议是基于可流式 HTTP 的 JSON-RPC 2.0。

macOS / Linux

终端

# Set your API key as a variable
export BUGAGENT_API_KEY="ba_live_YOUR_KEY_HERE"

# 1. List all available tools
curl -N -s https://mcp.bugagent.com/mcp \
  -H "Authorization: Bearer $BUGAGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json, text/event-stream" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'

# 2. Call a tool — list 5 reports from a specific project
curl -N -s https://mcp.bugagent.com/mcp \
  -H "Authorization: Bearer $BUGAGENT_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json, text/event-stream" \
  -d '{
    "jsonrpc":"2.0",
    "id":2,
    "method":"tools/call",
    "params":{
      "name":"list_bug_reports",
      "arguments":{"project":"bugagent","limit":5}
    }
  }'

Windows（PowerShell）

PowerShell

# Set your API key
$env:BUGAGENT_API_KEY = "ba_live_YOUR_KEY_HERE"

# Use Invoke-RestMethod (PowerShell's curl equivalent)
$headers = @{
  "Authorization" = "Bearer $env:BUGAGENT_API_KEY"
  "Content-Type" = "application/json"
  "Accept" = "application/json, text/event-stream"
}

# 1. List all tools
$body = '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'
Invoke-RestMethod -Uri "https://mcp.bugagent.com/mcp" `
  -Method Post -Headers $headers -Body $body

# 2. Call list_bug_reports for a specific project
$body = @{
  jsonrpc = "2.0"
  id = 2
  method = "tools/call"
  params = @{
    name = "list_bug_reports"
    arguments = @{ project = "bugagent"; limit = 5 }
  }
} | ConvertTo-Json -Depth 5

Invoke-RestMethod -Uri "https://mcp.bugagent.com/mcp" `
  -Method Post -Headers $headers -Body $body

响应以服务器发送事件（MCP 可流式 HTTP 标准）的形式到达。每个块都是一行，前缀为 data:，后跟一个 JSON 对象。Accept: application/json, text/event-stream 标头是必需的——没有它，服务器会拒绝请求。

ℹ️

401 未授权故障排除： 检查您的 API 密钥是否已在 设置 → API 密钥 中被撤销。密钥以 ba_live_ 开头。如果仍然卡住，请重新生成密钥并重试。

试试看 — 纯英文提示

连接后，您无需知道工具名称或参数。用纯英文描述您想要的内容，您的 AI 助手会自动调用正确的 bug_Agent_ 工具。

错误报告

询问您的 AI 助手

List my 5 most recent bug reports
Show all open critical bugs in the Auth project
Create a bug titled "Login broken on Safari" with severity s2
Update TEST-451 status to in-progress and assign it to me
Add a comment to TEST-451: "root cause confirmed — null check missing in auth middleware"
Show me everything filed this week, grouped by severity

测试管理

Create a test suite called "Smoke Tests" with cases for login, checkout, and account settings
Run the Regression suite and list all failures
Show failing test cases from the last 7 days
Which test cases have never been run in the past 90 days?
Get a pass-rate trend for this month vs last month

安全与性能

Run a security scan on https://app.example.com
Get this month's security scan results — show only high and critical findings
Create a performance test for the landing page and check Lighthouse scores
What are the Core Web Vitals for our checkout flow?

Playwright 自动化

Create a Playwright script that logs in and verifies the dashboard loads
Run the checkout automation on iPhone 15 Pro on a real device
Optimize the login automation script
Show runs for the checkout automation — any failures?
Schedule the smoke test suite to run every weekday at 6 AM UTC

探索性 AI

Run an exploratory AI session on https://app.example.com with 5 parallel agents
Get the latest exploration run results — list any bugs that were filed
What testing strategies did the agents use and which found the most issues?

使用情况与统计

Check my plan usage for this month
Show team bug stats for this week broken down by severity and type
List all team members and their roles
How many security scans do I have left this month?

快速参考

所有八个客户端的配置文件位置。每个客户端都通过可流式 HTTP 连接到 https://mcp.bugagent.com/mcp，并带有标头 Authorization: Bearer ba_live_YOUR_KEY_HERE。

客户端 配置位置 / 命令

MCP Inspector 无文件 — 在 npx @modelcontextprotocol/inspector 后的浏览器界面中输入 URL 和身份验证标头

Claude Desktop — macOS ~/Library/Application Support/Claude/claude_desktop_config.json

Claude Desktop — Windows %APPDATA%\Claude\claude_desktop_config.json

Claude Code (CLI) claude mcp add --transport http bugagent https://mcp.bugagent.com/mcp --header "Authorization: Bearer ba_live_..."

Codex CLI ~/.codex/config.toml

Cursor — macOS 设置 → MCP 界面，或 ~/.cursor/mcp.json

Cursor — Windows %USERPROFILE%\.cursor\mcp.json

VS Code + Continue ~/.continue/config.json (macOS) / %USERPROFILE%\.continue\config.json (Windows)

直接 HTTP (curl) curl / Invoke-RestMethod — 包含 Accept: application/json, text/event-stream

故障排除

症状 修复方法

401 Unauthorized 密钥错误、已过期或已撤销。检查 设置 → API 密钥 —— 密钥以 ba_live_ 开头。如有需要，请重新生成。

工具未在客户端显示 编辑配置后，完全退出并重新启动客户端。在 Claude Desktop 中，使用 Cmd+Q（而不仅仅是关闭窗口）。在 Cursor 中，检查 设置 → MCP 是否有绿点。

Accept header required 直接 HTTP 调用必须包含 Accept: application/json, text/event-stream —— 可流式 HTTP 规范要求这样做。没有它，服务器会返回 406。

错误工作区的数据 每个 API 密钥都限定在一个工作区内。从您要查询的工作区在 设置 → API 密钥 中生成一个新密钥。

工具出现但调用静默失败 确认服务器可达：curl -I https://mcp.bugagent.com/health 应返回 200。如果超时，请检查网络/防火墙规则。

MCP Inspector CORS 错误 在 Inspector 界面中为连接类型选择 代理（而不是直接）。Inspector 通过本地 Node 进程代理以绕过浏览器 CORS 限制。

Codex CLI — 无法识别工具 验证 ~/.codex/config.toml 是否使用 [[mcp_servers]]（双括号，数组语法）。检查 Codex CLI 版本是否足够新以支持 MCP（codex --version）。

MCP 功能

bug_Agent_ MCP 服务器提供以下工具：

🐛

错误报告管理

  • create_bug_report — 提交一份新报告，并自动分类为 19 种类型——包括缺陷、功能请求、改进、技术债务等（标题：3-500 个字符）。可选的 attachments 数组接受每个最大 400 MB 的 base64 编码文件：任何图像、视频、音频、PDF 或文本/JSON。设置 format_description: true 可使用 AI 将描述自动重新格式化为结构化模板。传递 time_spent_seconds 以跟踪 QA 工作量。传递 priority（urgent / high / normal / low）以独立于严重性设置修复紧急程度。响应包括 project_id、project、short_id、legacy_short_id 和 project_short_id。
  • list_bug_reports — 列出并筛选报告（每页最多 100 条）。项目筛选器在分页之前在服务器端应用。可按 project（UUID、slug、确切名称或工单前缀）、project_id、project_slug、project_prefix、workspace（UUID、确切名称或工作区工单前缀）、workspace_id/team_id、type（19 个仪表板类别之一）、severity（s1-s4 或旧版 critical/high/medium/low）、status（使用仪表板的确切值：new、awaiting-triage、confirmed、in-progress、blocked、resolved、retesting、closed、reopened——连字符是特意保留的）、resolution（fixed / duplicate / works-as-designed / cannot-reproduce / will-not-fix / need-more-info / unresolved）、root_cause（开放式的 kebab-case 标签——常见值：regression、missing-requirement、documentation、incomplete-refactor、not-a-bug、requirements-mismatch）或 reporter_user_id（提交报告的团队成员的 UUID——先调用 list_team_members 将姓名解析为 UUID）进行筛选。每个结果都包含 reporter_user_id、project_id、project、short_id、legacy_short_id 和 project_short_id，以便代理可以链接和更新正确的项目范围报告。
  • pick_next_bug — 按优先级顺序（S1 → S2 → S3，每个桶内最旧的优先）返回代理循环应处理的下一个（或多个）缺陷。自动限定到您的工作区——返回团队中所有项目中状态为 status new、awaiting-triage 或 confirmed 且严重性为 S1-S3 的工单。只读——不会原子性地认领工单。可选的 severity（单个层级）、limit（1-50，默认 1）。返回的行与 list_bug_reports 形状相同，以实现工具可组合性。与 claim_bug 配对使用，实现先读后认领的模式。
  • claim_bug — 原子性地将缺陷从 status new、awaiting-triage 或 confirmed 转换为 status='in-progress'，将 assigned_to 设置为调用用户，并标记 claimed_at=NOW()。通过 Postgres 的 UPDATE-WHERE-RETURNING 模式在并发调用者之间实现无竞争——如果两个代理在很短时间内对同一 ID 调用 claim_bug，则恰好一个会得到带有缺陷主体的 claimed:true，另一个会得到带有原因字符串的 claimed:false。pg_cron 回收器会自动将过时的认领（状态=in-progress 且 claimed_at > 30 分钟）释放回 new，因此崩溃代理的工单无需手动干预即可重新进入队列。输入：id（UUID 或短 ID）。
  • get_bug_report — 通过 ID 获取报告的完整详细信息。ID 格式： 接受 UUID（例如 1fb72a2c-87c7-...）、工作区范围的短 ID（例如 WRKID-545）或项目范围的短 ID（例如 WRKID-APP-042）。短 ID 查找限定在团队范围内——猜测其他工作区的短 ID 会返回 404。返回 project_id、project、short_id、legacy_short_id、project_short_id、ticket_number、project_ticket_number、qualityScore（整数 1–10）和 qualityBreakdown（包含 10 个维度分数的对象：reproductionSteps、expectedVsActual、environmentDetails、evidence、rootCauseAnalysis、impactAssessment、contextAndHistory、heuristicsAndOracles、clarityAndStructure、actionability——每个 0.0–1.0）。
  • update_bug_report — 更新现有报告上的字段。接受 UUID 或短 ID（WRKID-545）。可更新的字段包括 title、description、type（19 个仪表板类别中的任何一个）、severity、priority（urgent / high / normal / low——修复紧急程度，独立于严重性）、status（与仪表板完全匹配：new、awaiting-triage、confirmed、in-progress、blocked、resolved、retesting、closed、reopened——连字符是特意保留的）、resolution（fixed / duplicate / works-as-designed / cannot-reproduce / will-not-fix / need-more-info / unresolved）和 root_cause（开放式的 kebab-case 标签——常见值：regression、missing-requirement、documentation、incomplete-refactor、not-a-bug、requirements-mismatch）。代理循环约定要求，每当 status 转换出 new 时，必须同时设置 resolution 和 root_cause；仪表板、分析以及未来的 claude-bot 训练语料库都依赖于这些字段。还包括 assigned_to（来自 list_team_members 的用户 ID）和用于计时器跟踪的 time_spent_seconds。更改 assigned_to 会自动触发应用内铃铛通知以及发送给新受理人的礼貌电子邮件（尊重他们在账户设置中的每用户退出选项——与仪表板端点使用相同的管道）。
  • add_comment — 向缺陷报告添加评论（UUID 或短 ID，正文 1-10000 个字符）。如果报告已同步到 Jira，评论会自动推送到链接的 Jira 问题。
  • list_comments — 列出报告的完整评论线程，最早的在前——每条评论包含作者姓名、parentId（线程回复）和时间戳。评论不是 get_bug_report 的一部分，因此这是您阅读工单讨论的方式。接受 UUID 或短 ID。
  • link_bug_reports — 在同一工作区的两个缺陷报告之间创建定向语义链接。link_type 是 duplicate-of、parent-of、related-to 或 depends-on 之一。反向视角（duplicated-by / subtask-of / blocks）在读取时派生——只需存储一行。from_report_id 和 to_report_id 都接受 UUID 或短 ID（WRKID-545）。
  • unlink_bug_reports — 通过其 UUID（link_id，由 link_bug_reports 或 list_bug_report_links 返回）删除先前创建的缺陷报告链接。
  • list_bug_report_links — 列出涉及某个缺陷报告的所有用户策划的链接。从所提供报告的角度返回每个链接——例如，如果此报告是目标，则存储的 duplicate-of 行会呈现为 duplicated-by；如果此报告是目标，则 parent-of 会呈现为 subtask-of；如果此报告是目标，则 depends-on 会呈现为 blocks。related-to 是对称的。补充了由 get_bug_report 返回的自动检测的 similar_reports 字段。
  • classify_bug — 将描述分类为 19 种报告类型之一（缺陷、功能、改进等），并给出置信度分数
  • flush_reports — 批量删除旧报告（仅限管理员）

📊

使用与分析

  • get_usage — 根据计划限制检查使用情况
  • get_stats — 每日计数、类型/严重性/状态细分

📁

项目管理

  • list_projects — 列出可用项目，包含 id、name、slug、ticket_prefix、描述和默认状态。将这些值与 create_bug_report 和 list_bug_reports 一起使用，以定位正确的项目。
  • create_project — 创建一个新项目（如果是第一个，则自动成为默认项目）
  • delete_project — 永久删除一个项目及其所有关联数据（缺陷报告、自动化、测试用例、移动应用、计划、地理快照、笔记、时间条目）。仅限所有者/管理员。无法删除最后一个项目。存储空间会自动释放
  • export_okf_bundle — 将项目的 QA 知识——缺陷报告、测试用例、自动化以及性能、安全和探索性测试——导出为 OKF/OQA markdown 包（oqa.ai 使用的 Open Query Agent 格式）。默认为活动项目；传递可选的 project（slug 或名称）以导出不同的项目。返回包中的文件列表以及作为 base64 编码 zip 的包本身

🔐

身份验证与账户

  • register_account — 创建新账户（密码：8-128 个字符，速率限制：5 次/15 分钟）
  • login — 登录并接收访问令牌（速率限制：5 次/15 分钟）
  • update_profile — 更新显示名称
  • change_password — 更改账户密码
  • get_settings / update_settings — 管理偏好设置

🔑

API 密钥管理

  • generate_api_key — 创建命名的 API 密钥
  • list_api_keys — 列出活动密钥（仅前缀）
  • regenerate_api_key — 撤销并替换密钥
  • delete_api_key — 永久撤销密钥

👥

团队管理

  • list_team_members — 列出工作区的所有成员，包含角色、状态和助推器标志
  • invite_team_member — 通过电子邮件邀请用户（管理员可以邀请贡献者和管理员；只有所有者可以邀请管理员）。5 天过期链接

🎯

集成

  • sync_to_jira — 使用团队的共享连接将报告同步到 Jira
  • push_to_claude — 为缺陷报告生成（或重新生成）开发者笔记——根本原因、建议修复、验证步骤和风险评估。接受 UUID 或短 ID（WRKID-545）。使用平台密钥——无需每个团队的 Claude 连接。运行自适应链：对于 s3/medium 或 s4/low 缺陷，三步（Sonnet 草稿 → OpenAI gpt-5 评论 → Sonnet 综合），对于前两个严重性桶——s1/critical 或 s2/high——五步（草稿 → 评论 → Sonnet 反驳 → Claude Opus 裁决者，读取完整记录并以独立判断撰写最终笔记）。响应公开每一轮：analysis、draft、critique、rebuttal、challenger_model、adjudicator_model 和一个 debated 标志。任何步骤失败都会回退到次优答案。在缺陷创建时自动触发；通常仅在手动重新生成时调用。
  • analyze_fix_area — 生成（或重新生成）开发者笔记的“可能修复区域”子块——一个简短的 Sonnet 输出，指出修复最可能属于代码库中的哪个位置。接受 UUID 或短 ID。使用平台 Anthropic 密钥。当团队有 github_connections 行且项目有映射的 github_repo 时，输出基于连接仓库中的真实文件片段；否则回退到一般指导，并提示连接仓库。返回 likely_fix_area 文本、generated_at、repo_used 和一个 grounded 标志。在缺陷创建时自动触发——代理通常只需要在手动重新生成时调用此功能。
  • upgrade_plan — 通过 Stripe 升级订阅

⚡

性能测试

  • create_performance_test — 创建性能测试配置，包含 URL、设备、虚拟用户数、持续时间、评分阈值和自动创建缺陷开关。仅限企业版
  • run_performance_test — 为 Web 性能测试触发页面审计和负载测试。返回一个运行 ID，用于轮询结果。移动应用性能分析从仪表板触发
  • get_performance_results — 获取完整结果，包括 Lighthouse 评分（性能、可访问性、最佳实践、SEO）、核心 Web 指标（LCP、FID、CLS、FCP、TTFB、INP、TBT、SI）和负载测试指标（VU、请求数、RPS、p50/p90/p95/p99 延迟）
  • list_performance_tests — 列出当前团队的所有性能测试配置
  • get_performance_usage — 检查每月性能测试使用量。性能测试仅限企业版。免费版=0，企业版=无限制

示例工作流

  1. get_performance_usage → 检查剩余配额
  2. create_performance_test → 为你的 URL 配置测试
  3. run_performance_test → 触发审计 + 负载测试
  4. get_performance_results → 查看评分和核心指标

🛡

安全扫描

  • create_security_scan — 创建安全扫描配置。Web 扫描使用快速扫描器 + Nuclei（4000+ 模板），具有三个深度级别和可选的身份验证扫描。移动扫描使用 MobSF 进行 APK/IPA 二进制分析。可配置的自动缺陷创建，带有严重性阈值。仅限企业版
  • run_security_scan — 触发漏洞扫描。Web 扫描需要 DNS 域名验证。移动扫描需要上传的应用。返回一个运行 ID，用于轮询结果
  • get_security_results — 获取完整结果，包括安全评分（0-100）、按严重性分类的发现（严重、高、中、低、信息），并附带 CWE 参考、OWASP 映射、证据和修复指导
  • list_security_scans — 列出当前团队的所有安全扫描配置，包含上次评分和身份验证/深度标记
  • get_security_usage — 检查每月安全扫描使用量。安全扫描仅限企业版。企业版=无限制
  • list_security_schedules — 列出团队的所有计划安全扫描，包含 cron 表达式、时区、启用状态、下次运行时间和通知设置。与父级扫描配置（名称、scan_type、target_url）关联
  • create_security_schedule — 为安全扫描创建定期计划。需要 scan_id 和 cron_expression。每个扫描配置一个计划。可选的 timezone、notify_on_fail（none/email/slack/both）、notify_email、slack_channel_id。每次运行都计入你的每月上限；管理员用户可绕过上限。扫描深度始终在运行时从扫描配置中读取
  • delete_security_schedule — 删除计划的安全扫描。不影响父级扫描配置或已完成的运行
  1. get_security_usage → 检查剩余配额
  2. create_security_scan → 为你的 URL 或仓库配置扫描
  3. run_security_scan → 触发一次性漏洞扫描
  4. create_security_schedule → 自动化定期运行（例如，在主分支上每周进行 SAST）
  5. get_security_results → 查看发现和修复方案

📖

代码审查

  • list_code_reviews — 列出团队最近的 AI 代码审查。返回质量评分、严重性计数、PR 信息和时间戳。仅限企业版
  • get_code_review — 获取包含所有发现的代码审查。每个发现包括严重性、类别（bug/security/performance/style/logic/maintainability）、标题、描述、代码建议、文件路径和行号
  • get_code_review_usage — 检查代码审查使用量。AI 代码审查仅限企业版；企业版无限制
  • get_code_review_analytics — 获取审查分析：趋势、发现类别/来源、严重性细分、速度指标、热门仓库/作者。支持 7/30/90 天回溯
  1. get_code_review_usage → 检查剩余审查次数
  2. 在仪表板中审查 PR，地址为 /dashboard/code-review
  3. list_code_reviews → 查看最近的审查
  4. get_code_review → 获取发现和建议

🔍

探索式 AI

多智能体自主网站缺陷查找器，最多支持 10 个并行智能体，每个智能体使用不同的测试策略。

  • list_explorations — 列出团队的探索式 AI 配置
  • create_exploration — 创建新的探索。接受 agent_count（1–10，最大 10）以运行多个具有独特策略的并行智能体：happy_path、edge_case、security、accessibility、error_path、performance、mobile、data_integrity、navigation、custom
  • get_exploration — 获取包含智能体设置和最近运行的探索配置
  • get_exploration_run — 获取运行结果，包含每个智能体的进度、阶段数据、带有智能体归属的发现（agent_index、agent_strategy）和关联的缺陷
  • get_exploration_usage — 检查每月使用量。探索式 AI 仅限企业版；企业版：无限制（10 个智能体）
  1. 使用 create_exploration 和 agent_count: 5 → 配置 5 个并行智能体
  2. 从仪表板或通过 POST /api/explorations/run 触发运行
  3. get_exploration_run → 轮询每个智能体的进度和发现
  4. 在仪表板中查看带有智能体归属的去重发现

📝

笔记

  • list_notes — 列出笔记，支持可选的关键字搜索、项目筛选、作者筛选和日期范围。返回用户拥有的笔记或团队内共享的笔记。
  • create_note — 以 5 种格式之一创建笔记：markdown、plain_text、rich_text、checklist、outline。将 visibility 设置为 private 或 shared。如果未提供标题，则从前 30 个字符自动生成标题。可选的 attachments 数组接受每个最大 400 MB 的 base64 编码文件：任何图像、视频、音频、PDF 或文本/JSON。传递 time_spent_seconds 以跟踪 QA 工作量。
  • get_note — 获取完整的笔记详情，包括内容和附件。需要 id。
  • update_note — 更新标题、内容、格式、可见性、项目或 time_spent_seconds。传递一个 attachments 数组以将新文件（每个最大 400 MB）追加到笔记的现有附件中，而不替换它们。只有作者可以更新。需要 id。
  • delete_note — 永久删除笔记及其附件。只有作者可以删除。需要 id。
  1. create_note → 开始一个测试会话笔记
  2. update_note → 在测试时追加观察结果
  3. list_notes → 按关键字或项目搜索过去的笔记
  4. get_note → 检索包含附件的完整笔记

🤖

自动化

  • create_automation — 使用自定义 Playwright 脚本创建新的自动化（无需 FAB 录制）。需要 name。可选：target_url（如果省略，则从脚本中的第一个 page.goto(...) URL 自动派生）、script（Node.js/JavaScript/TypeScript 或 Python — 语言会自动检测；默认为占位符）、status（draft 或 active，默认：draft）、project_id。返回自动化 id。需要团队计划。提示 — 复制自动化： 使用 get_automation 获取原始脚本，然后调用 create_automation，将 name 设置为 "[Copy] Original Name"，并传递原始的 script、target_url 和 project_id。副本以 draft 状态启动，没有版本历史记录。
  • list_automations — 列出 Playwright 自动化脚本。按 project_id 或 status（draft、active、paused）筛选。返回自动化数组，包含名称、target_url、last_run_status 和 run_count。
  • get_automation — 获取完整的自动化详情，包括 Playwright 脚本和最近的运行。需要 id。返回包含实时 script、一个 script_versions 堆栈（最旧优先，最多 100 个先前条目，每个 { script, source, timestamp }）和一个 recent_runs 数组的自动化，其中每次运行都携带执行的 script_version_label/script_version_source。如果你需要选择特定的历史版本，请在 run_automation 之前调用此方法。
  • run_automation — 触发 Playwright 测试的立即运行。需要 automation_id。虚拟模式（默认）：可选的 device 用于视口模拟（例如 desktop、iphone-15）。实时模式：设置 browserstack: true，包含 bs_browser（chrome、firefox、safari、edge）、bs_os（Windows、OS X）和 bs_os_version，以在真实桌面浏览器上运行。实时真实移动设备： 设置 bs_os: "android"（设备："Samsung Galaxy S25 Ultra"、"Google Pixel 10"、"OnePlus 13R"）或 bs_os: "ios"（设备："iPhone 17 Pro Max"、"iPhone 16 Pro Max"、"iPhone 15 Pro Max"），并在 bs_os_version 中传递设备名称。Node.js 脚本通过 browserstack-node-sdk 路由（涵盖桌面 + Android + iPhone）。Python 脚本通过 browserstack-sdk（pytest-playwright）路由，仅涵盖桌面 — 不支持通过 Python 进行真实移动设备测试，因为 pytest-playwright 的 browser_type.connect() 无法驱动 BrowserStack 的真实移动设备端点。视频和网络日志自动捕获；控制台日志仅限桌面。版本重放： 传递可选的 version_index（整数，0 索引）以执行自动化 script_versions 历史记录中的先前条目。默认：当 version_index 被省略或为 null 时，运行当前的实时脚本 — 不要仅仅为了“选择当前”而传递占位符值。超出范围、负数或非整数值将被拒绝。运行记录存储运行的确切快照，并且从失败运行自动创建的任何缺陷报告都会在编辑器中深度链接回该版本。
  • list_automation_runs — 列出自动化的最近运行。需要 automation_id。返回包含状态、duration_ms 和 error_message 的运行。
  • list_schedules — 列出所有计划的 Web 自动化运行，包含 cron 表达式、时区、设备和通知设置
  • create_schedule — 创建计划的 Web 自动化运行。需要 automation_id 和 cron_expression。支持设备、时区、notify_on_fail（email/slack/both）和 Slack 频道选项。计划运行上的 BrowserStack Live：传递 browserstack: true，包含 bs_browser、bs_os 和 bs_os_version — 与 run_automation 相同的设备矩阵（Node = 桌面 + 真实 Android + 真实 iPhone；Python = 仅桌面）。
  • delete_schedule — 删除计划的 Web 自动化运行
  • list_mobile_schedules — 列出所有计划的移动自动化运行，包含设备、cron 表达式、时区和通知
  • create_mobile_schedule — 在真实设备上创建计划的移动自动化运行。需要 automation_id、cron_expression 和 devices 数组
  • delete_mobile_schedule — 删除计划的移动自动化运行
  • optimize_automation_script — 将 Playwright 脚本发送到 Sonnet 4 进行 AI 驱动的优化。应用一个 12 点检查清单，修复选择器、等待策略、断言、错误处理、身份验证模式、移动兼容性和严格模式。需要 automation_id。当前脚本版本在优化前保存。返回优化后的脚本和更改摘要。
  • undo_automation_script — 将自动化脚本恢复到其先前的版本。最多保留 10 个先前版本。需要 automation_id。返回恢复的脚本和剩余的版本数量。
  1. create_automation → 使用自定义脚本创建测试
  2. list_automations → 浏览可用的测试
  3. get_automation → 检查 Playwright 脚本
  4. run_automation → 触发测试
  5. list_automation_runs → 检查结果和持续时间

⏱️

时间跟踪* list_time_entries — 列出团队的时间条目。可按 period（today、week、month、all）、project_id、category 和 sort（newest、oldest、most_time、least_time）进行筛选。仅限团队计划。

  • create_time_entry — 记录在 QA 任务上花费的时间。需要 description、category 和 duration_minutes。可选择设置 project_id 和 entry_date（默认为今天）。仅限团队计划。
  • update_time_entry — 更新现有的时间条目。需要 id。可更新 description、category、duration_minutes、project_id 或 entry_date。仅限团队计划。
  • delete_time_entry — 永久删除一个时间条目。需要 id。仅限团队计划。
  1. create_time_entry → 记录 45 分钟的回归测试
  2. list_time_entries → 查看本周的时间条目
  3. update_time_entry → 调整时长或类别
  4. delete_time_entry → 删除错误的条目

☑️

测试用例

全面的测试管理，支持层级文件夹、嵌套套件（最多 3 层深，运行时可自动展开子套件）、拖拽排序、AI 辅助用例生成，以及包含 KPI 趋势、失败分析、套件健康度、覆盖率和测试人员生产力的分析报告选项卡。所有工具直接调用 Supabase——无 HTTP 往返，延迟与仪表板相同。

免提执行：运行审查页面是一个轮播视图，一次显示一个用例，支持键盘快捷键（P 通过 · F 失败 · B 阻塞 · S 跳过）和语音控制。点击麦克风，然后说出“通过”、“失败”、“阻塞”、“跳过”、“下一个”、“上一个”、“添加备注”（转录到备注字段）、“保存备注”或“关闭语音”。成功结果会自动前进到下一个未测试的用例；失败时则停留在当前用例，以便测试人员口述详细信息并生成缺陷。适用于 Chrome、Edge 和 Safari。

用例与文件夹
  • list_test_cases — 列出测试用例，可选参数包括 search、priority（critical、high、medium、low）、type（functional、regression、smoke、integration、performance、security、usability、exploratory）、status（active、draft、deprecated）和 sort（newest、oldest、name、priority）。
  • create_test_case — 创建测试用例。有两种模板变体：steps（默认）— 通过 steps 数组实现按步骤的 { action, expected } 网格；text — 通过 text_content 实现单一自由格式描述。两个字段可在同一次调用中发送（平台独立存储它们，因此测试人员稍后切换 template_type 时不会丢失任何一方的数据）。可选的 urls 数组（最多 10 个 http/https URL）用于附加参考链接。需要 name。可选：description、preconditions、template_type、steps、text_content、urls、priority、type、tags、estimated_time（秒）。文件附件通过仪表板的 POST /api/test-cases/:id/attachments 端点（multipart）上传——尚未作为 MCP 工具公开。
  • get_test_case — 获取完整的测试用例详情，包括步骤和执行历史。
  • list_test_case_folders — 列出团队的文件夹（每个用例通过 folder_id 对应一个文件夹；与套件不同，套件是多对多的测试计划分组）。上限为 500；支持 project_id 和 parent_folder_id 筛选器（使用 "root" 仅获取顶级文件夹）。
  • create_test_case_folder — 创建文件夹（通过 parent_folder_id 最多嵌套 3 层）。使用 bulk_update_test_cases 将用例移入其中。
  • bulk_update_test_cases — 一次对最多 500 个用例执行一个操作：set_priority、set_status、set_type、add_tags、remove_tags、add_to_suite、pin、unpin。
  • link_test_case_to_bug — 在测试用例和缺陷报告之间建立可追溯性（verified_by、covers 或 relates）。
  • list_test_case_links — 列出测试用例的所有可追溯性链接。
  • list_test_case_review_candidates — 死测试标志：never_run（创建后超过 90 天）、always_passes（90 天内连续通过 5 次以上）、always_skipped（连续跳过 3 次以上）。
  • mark_test_case_review_flags — 将当前的归档候选标志持久化到 test_cases.review_flag。通过 pg_cron 每周一 09:00 UTC 自动运行。
导入
  • Figma 导入（仪表板 UI + REST）：上传 Figma 画板的 zip 导出文件（最大 100 MB），Claude 会分析每个屏幕，并将测试用例草稿放入你选择或创建的文件夹中。多通道流水线（分类 → 逐屏用例 → 跨共享前缀屏幕的流程级用例 → 自我审查），具有提示缓存、429 重试和逐帧错误隔离功能，因此一个坏帧不会导致整个批次失败。用例以 status=active 形式落地，标记为 ai_generated=true，并带有 source='figma' 和 source_frame_name，保留指向原始画板的链接。使用平台 Anthropic 密钥——无需每个团队连接 Claude。端点：POST /api/test-cases/import/figma/request、POST /api/test-cases/import/figma/start、GET /api/test-cases/import/figma/:id。
套件与运行
  • list_test_suites — 列出测试套件，包含用例数量和上次运行状态。
  • create_test_suite — 创建套件。通过 parent_suite_id 最多嵌套 3 层。
  • list_test_runs — 列出测试运行，包含套件名称、负责人和通过/失败摘要。
  • create_test_run — 将套件快照生成新的运行。运行父套件会自动包含每个后代子套件中的每个用例（同时链接到两者的用例只会添加一次）。每个 test_run_results 行记录用例来自哪个原始子套件，因此结果页面可以按来源分组。
报告（Tier 1 + Tier 4 分析）
  • get_test_reports_overview — 某个时间窗口的标题 KPI（通过率、完成的运行次数、执行的用例数），以及与上一个同等窗口的差异。与报告选项卡 KPI 条显示的数字相同。
  • get_test_reports_failures — 四个“需要修复什么？”列表：failing_cases（失败率 ≥50%，最少 3 次运行）、flaky_cases（通过/失败翻转最多）、failing_suites（失败率 ≥30%，最少 5 次运行）、regressed_cases（窗口内最近一次失败且之前有过通过）。
  1. create_test_case_folder → 创建文件夹树（例如 Smoke → Auth）
  2. create_test_case → 定义用例；使用 bulk_update_test_cases 将其移入文件夹
  3. create_test_suite → 构建测试计划（子套件可选，最多 3 层深）
  4. create_test_run → 从父套件快照生成运行——子套件自动包含
  5. get_test_reports_failures → 运行完成后询问“本周需要修复什么？”
  6. get_test_reports_overview → 逐周跟踪通过率趋势

⚡

团队助推器

  • scale_team — 使用助推测试人员即时扩展你的 QA 团队。账户会自动配置并授予测试人员访问权限。指定 team_size（1–10）、location、duration、budget，以及可选的 product_url、product_types 和 tech_levels。适用于团队计划。在获得批准之前，你不会被收费。
  1. scale_team → 在美国配置 5 名高级测试人员，为期 1 个月
  2. list_team_members → 验证新测试人员是否出现在你的团队中
  3. list_reports → 审查助推测试人员提交的报告

📱

移动测试

  • upload_mobile_app — 上传 APK（Android）或 IPA（iOS）应用，以便在真实设备上进行测试。需要 name、platform（android/ios）和 file_url。对于 iOS：上传 IPA 用于真实设备运行，然后在应用详情页上传模拟器 .app 构建版本以启用录制。
  • update_mobile_app — 用新版本替换应用二进制文件。清除缓存的 URL 和模拟器构建，以便所有自动化在下次运行时使用新版本。需要 app_id 和 file_url。可选：version。
  • create_mobile_automation — 创建测试脚本。需要 name、app_id、script_type（maestro 用于 YAML，appium 用于 Appium Python，appium_js 用于 Appium JavaScript）和 script（测试脚本内容）。
  • list_mobile_runs — 获取移动测试运行的结果（状态、设备、视频、BrowserStack 会话以及任何自动创建的缺陷）。移动运行从仪表板或按计划触发。可选筛选器：automation_id、status（queued、running、passed、failed、error、archived）、limit。默认列表中排除已归档的运行。

示例工作流 — Android

  1. upload_mobile_app → 上传你的 APK
  2. 在浏览器中录制测试 → 自动捕获操作
  3. 从仪表板或按计划在真实设备（例如 Google Pixel 8）上触发运行
  4. list_mobile_runs → 检查结果，包括视频和日志
  5. 失败会自动创建缺陷报告，包含失败快照和步骤分解

示例工作流 — iOS

  1. upload_mobile_app → 上传你的 IPA（用于真实设备运行）
  2. 在应用详情页上传模拟器 .app 构建版本（用于录制）
  3. 在浏览器中录制测试 → 从模拟器捕获操作
  4. 从仪表板或按计划在真实设备（例如 iPhone 15 Pro，使用 IPA）上触发运行
  5. update_mobile_app → 准备就绪后，用新版本替换 IPA

✅

合规与证据（企业版）

  • collect_compliance_evidence — 从连接的服务（Cloudflare、GitHub、Sentry、Supabase、Railway）触发自动证据收集。返回运行 ID。收集 SSL/TLS 设置、WAF 状态、Dependabot 警报、错误趋势、部署历史等。
  • check_config_drift — 检查所有连接的服务是否存在与基线的安全配置偏差（SSL 模式、TLS 版本、HSTS、WAF 规则、安全标头）。
  • generate_access_review — 创建季度访问审查报告。审计团队成员、角色、MFA 状态、API 密钥使用情况，并生成建议（例如，撤销不活跃的密钥）。
  • get_security_events — 查询跨服务安全事件时间线。可按来源（cloudflare、sentry、github）和严重性（critical、high、medium、low、info）筛选。事件会跨服务自动关联。

合规覆盖范围

这些工具有助于满足 SOC2（CC4.1、CC6.1、CC7.2、CC8.1）、ISO 27001（A.5.18、A.8.8、A.8.9、A.8.15-16、A.8.29）和 GDPR（第 5、25、32、33 条）的合规要求。

兼容的客户端

bug_Agent_ 可与任何支持模型上下文协议的客户端配合使用。以下是流行客户端的设置指南：

🤖

Claude Desktop

打开设置 → 开发者 → 编辑配置，然后添加：

claude_desktop_config.json

保存后重启 Claude Desktop。

✳️

Cursor

打开设置 → MCP 服务器 → 添加服务器，或在项目根目录编辑 .cursor/mcp.json：

.cursor/mcp.json

🌊

Windsurf

打开设置 → MCP → 添加服务器，或编辑你的 MCP 配置文件：

mcp_config.json

💻

Claude Code (CLI)

直接从终端添加 bug_Agent_：

claude mcp add bugagent -- npx -y @bugagent/mcp-server

在启动前使用 export BUGAGENT_API_KEY=ba_live_... 设置你的 API 密钥。

🔧

其他 MCP 客户端

任何支持 MCP stdio 传输的客户端都可以使用 bug_Agent_。使用标准配置：

  • 命令：npx
  • 参数：["-y", "@bugagent/mcp-server"]
  • 环境变量：BUGAGENT_API_KEY

CLI

CLI 入门

bug_Agent_ CLI 让你可以从终端完全控制缺陷报告、功能请求、项目和集成。使用它可以：

  • 自动化工作流 — 将缺陷报告集成到 CI/CD 管道、脚本和定时任务中
  • 批量操作 — 无需离开终端即可列出、筛选和管理报告
  • 管道友好的输出 — JSON、YAML 和原始格式，可与 jq、yq 及其他工具组合使用
  • 快速迭代 — 无需浏览器，几秒钟内即可创建和更新报告

安装

npm install -g @bugagent/cli

验证安装：

bugagent --version

认证

将您的 API 密钥设置为环境变量：

或直接通过 --api-key 标志传递：

bugagent reports list --api-key ba_live_your_key_here

🔑

从 bug_Agent_ 控制台获取您的 API 密钥。密钥以 ba_live_ 开头。

如需持久认证，请将 export 命令添加到您的 shell 配置文件（~/.bashrc、~/.zshrc 等）。

用法

命令遵循以下模式：

bugagent <resource> <action> [flags]

资源也可以使用冒号语法来访问子资源：

bugagent reports comments add --report-id WRKID-545 --body "Reproduced on v2.1"

在任何命令上使用 --help 以查看详细信息：

bugagent reports --help
bugagent reports create --help

示例会话

终端

# List your projects
bugagent projects list

# Create a bug report in your default project
bugagent reports create \
  --title "Checkout 500 on discount code" \
  --description "Applying SAVE20 returns HTTP 500" \
  --severity critical \
  --type logic

# View recent reports
bugagent reports list --limit 5 --format pretty

# Get full details on a report (use the short ID or UUID)
bugagent reports get WRKID-545

# Sync a report to Jira
bugagent jira sync --report-id WRKID-545

# Check your usage
bugagent usage get --format json

CLI 功能

CLI 提供以下命令：

reports 创建、列出、获取、更新和清空错误报告

projects 创建、列出、更新和删除项目

keys 生成、列出、重新生成和吊销 API 密钥

jira 连接、同步报告和配置 Jira 设置

usage 根据计划限制检查当前使用情况

stats 查看分析和细分数据

profile 查看和更新您的个人资料与设置

auth 登录、注册和管理凭据

全局标志

标志 描述

--api-key <key> 为此命令覆盖 API 密钥

--format <fmt> 输出格式：json、yaml、pretty、raw

--debug 显示请求/响应详细信息以进行故障排除

--help 显示任何命令的帮助信息

--version 打印 CLI 版本

输出格式

CLI 支持多种输出格式以满足不同用例：

json

机器可读的 JSON。非常适合通过管道传递给 jq 或其他工具。

yaml

人类友好的 YAML 输出，适用于配置文件和可读性。

pretty

默认格式。为终端设计的彩色、格式化输出。

raw

未格式化的输出。适用于脚本编写和自动化。

使用 --transform 进行过滤

使用 --transform 配合 GJSON 语法来查询和过滤输出数据：

# Default pretty output
bugagent reports list

# JSON for piping to other tools
bugagent reports list --format json

# YAML
bugagent reports list --format yaml

# Raw (no formatting)
bugagent reports get rpt_abc123 --format raw

# Filter with GJSON syntax
bugagent reports list --format json \
  --transform "items.#(severity==critical).title"

AI 技能

CLI 也可作为 AgentSkill 使用，允许 AI 编码助手代表您使用 bug_Agent_。

✨

什么是 AgentSkill？

AgentSkills 允许 AI 编码助手（Claude Code、Cursor 等）根据上下文调用 CLI 工具。bug_Agent_ 技能使您的 AI 助手能够提交错误、检查项目状态并同步到 Jira——所有这些都无需您输入命令。

安装技能

claude skills install bugagent --from @bugagent/mcp-server

安装后，具有上下文感知能力的 AI 助手可以自然地使用 bug_Agent_ 命令——并全面了解您的产品、测试指南和上传的文档：

AI 助手提示

"File a critical bug: the payment webhook is returning
a 403 after the latest deploy. It affects all Stripe
events. Assign it to the payments project."

该技能将自然语言翻译成相应的 CLI 命令并执行它们。

🎬

会话回放 + AI 助手： 当启用会话回放（团队计划）时，AI 助手可以引用捕获的用户会话——过去 60 秒内的点击、导航、错误和网络故障——以自动起草更丰富、更准确的错误报告，并提供完整的重现上下文。

获取帮助

需要帮助？我们随时为您服务。

Discord 社区

加入我们的 Discord，获取实时支持和社区讨论。

电子邮件支持

[email protected] — 我们通常在 24 小时内回复。