faros

Faros

Faros 是一个面向工程领导者的数据平台。它通过汇总各种工具中的数据，帮助他们了解软件开发生命周期。

官方文档：https://faros.ai/docs/

Faros 概览

• Faros AI 助手
  • 查询 — 表示提交给 Faros AI 的问题或请求。
  • 响应 — Faros AI 针对查询生成的答案或结果。

根据需要使用操作名称和参数。

使用 Faros

此技能使用 Membrane CLI 与 Faros 交互。Membrane 会自动处理身份验证和凭据刷新，因此你可以专注于集成逻辑，而不是身份验证的繁杂工作。

安装 CLI

安装 Membrane CLI，以便在终端中运行 membrane：

npm install -g @membranehq/cli@latest

身份验证

membrane login --tenant --clientName=<agentType>

根据是否支持交互模式，这会打开浏览器进行身份验证，或者在控制台中打印授权 URL。

**无头环境：**该命令会打印授权 URL。请让用户在浏览器中打开它。用户完成登录后会看到一个代码，请使用以下命令完成操作：

membrane login complete <code>

在任何命令后添加 --json，即可获得机器可读的 JSON 输出。

Agent 类型：claude、openclaw、codex、warp、windsurf 等。这些类型将用于调整工具，以便与你的运行环境更好地配合。

连接到 Faros

使用 membrane connection ensure，通过应用 URL 或域名查找或创建连接：

membrane connection ensure "https://www.faros.ai/" --json

用户在浏览器中完成身份验证。输出中包含新连接 ID。

这是创建连接最快的方式。URL 会规范化为域名，并与已知应用进行匹配。如果找不到应用，系统会创建一个应用并自动构建连接器。

如果返回的连接具有 state: "READY"，请跳到第 2 步。

1b. 等待连接就绪

如果连接处于 BUILDING 状态，请轮询，直到连接就绪：

npx @membranehq/cli connection get <id> --wait --json

--wait 标志会进行长轮询，最长等待 --timeout 秒（默认值为 30），直到状态发生变化。持续轮询，直到 state 不再是 BUILDING。

根据返回的状态决定下一步操作：

• READY — 连接已完成设置。跳到第 2 步。

• CLIENT_ACTION_REQUIRED — 用户或 Agent 需要执行某项操作。clientAction 对象会说明所需操作：

  • clientAction.type — 所需操作的类型：
    • "connect" — 用户需要进行身份验证（OAuth、API 密钥等）。这适用于初次身份验证，以及已断开连接的连接重新进行身份验证。
    • "provide-input" — 需要提供更多信息（例如要连接的应用）。
  • clientAction.description — 对所需操作的易读说明。
  • clientAction.uiUrl（可选）— 用户可在其中完成操作的预构建 UI URL。如果存在，请向用户展示。
  • clientAction.agentInstructions（可选）— AI Agent 如何以编程方式继续操作的说明。

  用户完成操作（例如在浏览器中进行身份验证）后，再次使用 membrane connection get <id> --json 轮询，检查状态是否已变为 READY。

• CONFIGURATION_ERROR 或 SETUP_FAILED — 出现问题。查看 error 字段了解详情。

搜索操作

使用自然语言描述你想执行的操作进行搜索：

membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json

务必在特定连接的上下文中搜索操作。

每个结果都包含 id、name、description、inputSchema（操作接受的参数）和 outputSchema（操作返回的内容）。

常用操作

名称	键	描述
列出图	list-graphs	列出 Faros 租户中的所有图
列出账户	list-accounts	列出 Faros 中的所有账户（数据源配置）。
列出 Webhook	list-webhooks	列出 Webhook，可选择按图和来源筛选
列出命名查询	list-named-queries	获取所有命名查询的列表
列出 API 密钥	list-api-keys	列出所有租户 API 密钥
列出账户同步状态	list-account-syncs	获取租户账户的同步状态列表
列出密钥	list-secrets	列出所有密钥，可选择按组筛选。
获取图	get-graph	按名称获取图
获取账户	get-account	按账户 ID 获取租户账户
获取 Webhook	get-webhook	按 ID 获取 Webhook 定义
获取命名查询	get-named-query	按名称获取命名（已保存）查询。
获取密钥	get-secret	按名称获取特定密钥，可选择指定组。
创建账户	create-account	为租户设置新账户
创建 Webhook	create-webhook	创建新的 Webhook 定义，以接收来自外部来源（GitHub、GitLab、Jira）的事件
创建命名查询	create-named-query	创建新的命名查询
创建 API 密钥	create-api-key	创建新的租户 API 密钥
创建密钥	create-secret	为给定名称创建密钥值
更新账户	update-account	更新 Faros 中的账户（数据源配置）。
更新 Webhook	update-webhook	更新现有的 Webhook 定义
删除账户	delete-account	删除租户账户

运行操作

membrane action run <actionId> --connectionId=CONNECTION_ID --json

传递 JSON 参数：

membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json

结果位于响应的 output 字段中。

代理请求

当可用操作无法满足你的使用场景时，可以通过 Membrane 的代理直接向 Faros API 发送请求。Membrane 会自动将基础 URL 附加到你提供的路径，并注入正确的身份验证标头；如果凭据过期，还会透明地刷新凭据。

membrane request CONNECTION_ID /path/to/endpoint

常用选项：

标志	描述
-X, --method	HTTP 方法（GET、POST、PUT、PATCH、DELETE）。默认为 GET
-H, --header	添加请求标头（可重复），例如 -H "Accept: application/json"
-d, --data	请求正文（字符串）
--json	发送 JSON 正文并设置 Content-Type: application/json 的快捷方式
--rawData	按原样发送正文，不进行任何处理
--query	查询字符串参数（可重复），例如 --query "limit=10"
--pathParam	路径参数（可重复），例如 --pathParam "id=123"

最佳实践

• 始终优先使用 Membrane 与外部应用通信 — Membrane 提供预构建操作，内置身份验证、分页和错误处理。这样可以减少令牌消耗，并使通信更安全
• 先探索，再构建 — 在编写自定义 API 调用之前，运行 membrane action list --intent=QUERY（将 QUERY 替换为你的意图），查找现有操作。预构建操作可处理原始 API 调用容易遗漏的分页、字段映射和边界情况。
• 让 Membrane 处理凭据 — 切勿向用户索要 API 密钥或令牌。请改为创建连接；Membrane 会在服务端管理完整的身份验证生命周期，无需本地密钥。