# @ever-works/composio-plugin 中文文档

规范地址：https://npmcn.com/package/%40ever-works/composio-plugin/

版本：1\.0\.18
npm 元数据更新时间：2026-11-03T08:56:18.734Z
中文译文更新时间：2026-11-14T01:26:15.076Z
软件包许可：AGPL-3\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40ever-works/composio-plugin
原文对照：https://npmcn.com/package/%40ever-works/composio-plugin/?lang=original
项目主页：https://github.com/ever-works/ever-works/tree/main/packages/plugins/composio#readme
源码仓库：https://github.com/ever-works/ever-works

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：435 kB，6 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：@ever-works/plugin ^1\.2\.16
- 首次发布：2026-06-06T08:18:28.384Z
- 最新版本发布：2026-11-03T08:56:18.331Z
- 近 30 天下载量：2762（2026-10-14 至 2026-11-12，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

Composio 集成插件 - 经纪人 OAuth 和工具执行通过 composio.dev 跨越 500+ apps

## 安装

```sh
npm install @ever-works/composio-plugin
```

也可以使用：`pnpm add @ever-works/composio-plugin`、`yarn add @ever-works/composio-plugin`、`bun add @ever-works/composio-plugin`

## README

# @ever-works/composio-plugin (英语)

Composio 集成管插件 - 执行 Composio 工具在工作生成期间跨越500+第三方应用.

## 插件元数据

| 外地 | 数值 |
| --- | --- |
| 身份证 | `composio` |
| 类别 | `pipeline` |
| 能力 | `pipeline`, (中文(简体) ), `form-schema-provider` |
| 作者 | 永远工作团队 |
| 许可证 | AGPL-3.0 导弹 |
| 内建 | 对 |
| 可自动启用 | 没有 |

## 作曲插件是做什么的?

此插件允许 Ever Works 调用任何 [组合](https://composio.dev/)'500+第三方集成(Gmail, Slack, GitHub, Notion, Linear, Salesforce, HubSpot, Frede, Shopify, Airtable,.)在工作生成期间. 作曲经纪 OAuth 代表您——每个用户一次通过作曲经纪主机流量连接一个应用,平台再利用该连接执行工具.

与其为用户想要整合的每一项服务写出每个应用程序的连接器,不如将一个插件(这个)传送给用户,用户则得到整个Composio目录. 插件通过官方引用工具 [`@composio/core`](https://www.npmjs.com/package/@composio/core) SDK(每个工作空间AGENTS.md NN #22 ——总是使用官方供应商SDK),并将结果作为管道输出返回到三种形状之一:结构 `{ items: [...] }`,带有场地映射的原生记录,或只具有副作用(火与遗忘).

## 为什么用它?

-   获得500+集成而不写入连接器代码.
-   OAuth 为您处理 : Composio 管理符、 刷新、 范围、 和利率限制 .
-   用户账户:每个用户在不共享证书的情况下连接自己的Gmail / Slack / GitHub.
-   三种执行形状——结构化项目,通过场地映射的本土记录,或副作用——来匹配不同的使用案例.
-   与原生 Ever Works 插件(github,概念-extractor,.)共存——在存在时使用专用插件,作曲用于其他一切.

## 怎样在永生工作

当选择此插件为活动管道时, 平台驱动 a `Composio` 客户端来自 `@composio/core` 通过6个相继步骤:

1.  **验证组合连接** —— 说 `composio.toolkits.get(...)` 确认接受 API 密钥,然后 `composio.connectedAccounts.list({ userIds, toolkitSlugs })` 确认用户对请求的工具包有ACTIE连接账户.
2.  **准备工具有效载荷** - 建设 `arguments` 对象带有工作元数据、可选的现有项目摘要、可选的 GitHub 数据存储器以及任何用户提供的工具参数.
3.  **执行计算工具** —— 说 `composio.tools.execute(toolSlug, { userId, arguments })`SDK解开v3响应信封(`{ successful, data, error, log_id }`为了我们.
4.  **收集验证结果( V)** ——对响应进行解析,必要时将项目记录到工作项目上,与现有项目相去相去.
5.  **抓取屏幕截图** (可选) — 使用已配置的截图插件来获取没有它们的项目的图像 .
6.  **清理** ——释放资源.

插件处理 **工具键** 作为某一行动的独特标识符(`GMAIL_SEND_EMAIL`, (中文(简体) ), `GITHUB_CREATE_ISSUE`(中文(简体) ). 工具包的弹片是信息化的,用于连接账户的验证.

## 开始

1.  报名到 [composio.dev (英语)](https://composio.dev/) 并抓取您的 API 密钥从 **设置 ~ API 密钥**。 。 。 .
2.  在您的混编下连接至少一个工具包( Gmail, GitHub, Slack,...) `user_id` 透过作曲仪表板.
3.  在 Ever Works 中打开 Composio 插件设置并粘贴 API 密钥 。 如果上游账户在不同的标识符(通常是电子邮件)下连接,则设置 **默认组合用户 ID** 对这个价值.
4.  在那个 **生成** 流程,设置工具包(例如:. `GMAIL`),工具弹(例如. `GMAIL_SEND_EMAIL`),结果形状,任何自定义工具参数,然后触发运行.

## 设置

-   `apiKey` (单位:千美元)**隐藏**—— 作曲 API 密钥, 传递给 `@composio/core` 施工时间为SDK.
-   `baseUrl` —— 覆盖 Composio API 基础 URL( 默认留空) `https://backend.composio.dev/api/v3`) (中文(简体) ).
-   `defaultUserId` ——作曲 `user_id` 以运行工具对抗。 默认为您的 Ever Works 用户 ID .
-   `defaultToolkit` ——默认工具包弹(例如. `GMAIL`) (中文(简体) ).
-   `defaultToolSlug` – 默认作曲工具 slump(例如. `GMAIL_SEND_EMAIL`) (中文(简体) ).

生成器还额外暴露了每个运行的选项,包括工具包、工具流、Composio用户ID覆盖、结果形状、本地记录的实地映射、自定义工具参数和工具超时.

## 结果模式

-   **结构化项目** ——当工具返回时使用 `items` 匹配工作项目形状的矩阵.
-   **土著记录** ——当工具返回原始记录(Gmail messages,Notion pages, GitHub Issues,.)时使用,并且您想要映射诸如名称,URL,描述,类别,标签,图像,品牌,或内容等字段.
-   **仅副作用** ——当工具应当发送消息,创建任务,更新另一个系统,或者触发另一个工作流程而不添加工作项目时使用.

## 作曲对本地 Ever 工程插件

Ever Works 运送一些本地插件(`github`, (中文(简体) ), `notion-extractor`直接与具体服务相结合。 作曲给你剩下的目录. 它们并存:为其覆盖的应用程序保留原生插件,并使用作曲来做其他一切. 本地插件通常提供更紧凑的集成(ricer distruction,自定义的UI提示,OAuth通过Ever Works自己的回调;Composio提供宽度.

## 解决问题

| 症状 | 可能的原因是 | 修补 |
| --- | --- | --- |
| 世代从不开始/留在 `0%` | `composio` 未选择此工程的运行中的管道插件 | 打开工作 **插件** → `pipeline` 能力和设置 `composio` 作为活动管道;或 设置为全球管道默认 **设置 — 插件** |
| `Composio rejected the API key (HTTP 401/403)` | API 密钥丢失或无效 | 于 [https://app.composio.dev/ settings/api-keys 页面存档备份,存于互联网档案馆](https://app.composio.dev/settings/api-keys) 粘贴到插件设置中 |
| `No active Composio connected account found for user "..." on toolkit "..."` | 用户未连接请求的工具包, 或连接为 `EXPIRED` 编号 : `REVOKED` | 打开 [https://app.composio.dev/connections 互联网档案馆的存檔,存档日期2014-10-02](https://app.composio.dev/connections) 并完成(或重新启动)工具包的OAuth流 |
| `Composio returned 404 for /tools/execute/...` | 工具弹片错误或已重命名 | 浏览 [https://app.composio.dev/tools (英语)](https://app.composio.dev/tools) 以查找当前 sattle; 工具 sattle 是大写和工具包前缀 |
| 工具成功但未返回项目 | 工具返回本地记录, 不是结构化项目 | 切换 **结果形状** 到“国内记录”并设置实地绘图(至少) `name_field`(中文(简体) ) |

## 地方发展

这个插件船与Ever Works平台一起内置. 从单列波根进行本地研究:

```bash
pnpm install
pnpm --filter @ever-works/composio-plugin build
pnpm --filter @ever-works/composio-plugin test
```

## 文档

-   [工程文档](https://docs.ever.works/)
-   [Ever 工程仓库](https://github.com/ever-works/ever-works)
-   [插件系统](https://npmcn.com/package/plugin/README.md)
-   [混音主页](https://composio.dev/)
-   [组合 v3 文件](https://docs.composio.dev/)

## 许可证

AGPL-3.0 导弹

## 常见问题

### @ever-works/composio-plugin 是什么？

Composio 集成插件 - 经纪人 OAuth 和工具执行通过 composio\.dev 跨越 500\+ apps

### 如何安装 @ever-works/composio-plugin？

在项目目录运行 npm install @ever-works/composio-plugin，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@ever-works/plugin（^1\.2\.16）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @ever-works/composio-plugin 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @ever-works/composio-plugin 支持 ESM 还是 CommonJS？

同时提供 ES Module 与 CommonJS 入口，import 和 require\(\) 都可以使用，打包工具会自动选择合适的版本。

### @ever-works/composio-plugin 可以商用吗？

@ever-works/composio-plugin 使用 AGPL-3\.0 许可。最严格的 Copyleft：除分发外，通过网络向用户提供基于它的服务也需要开源对应源码。闭源 SaaS 使用前务必评估。以上为概括，不构成法律意见，请以许可原文为准。

### @ever-works/composio-plugin 的下载量有多少？

根据 npm 官方下载统计，@ever-works/composio-plugin 在 2026/10/14 – 2026/11/12 这 30 天内被下载 2,762 次，日均约 92 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @ever-works/composio-plugin 还在维护吗？

最新版本 1\.0\.18 发布于 2026/11/03（10 天前）；至今共发布 15 个版本，其中过去 12 个月发布了 15 个；首次发布于 2026/06/06。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。