@ever-works/composio-plugin

中文文档
1.0.18发布于 2026/11/03AGPL-3.0TypeScriptESM + CJS构建来源已验证近 30 天下载 2762

Composio Integration Plugin - Brokers OAuth and tool execution across 500+ apps via composio.dev

原始使用文档
文档目录12 节
  1. Plugin metadata
  2. What does the Composio plugin do?
  3. Why use it?
  4. How it works in Ever Works
  5. Getting started
  6. Settings
  7. Result modes
  8. Composio vs. native Ever Works plugins
  9. Troubleshooting
  10. Local development
  11. Documentation
  12. License

@ever-works/composio-plugin

Composio Integrations Pipeline Plugin - Executes Composio tools across 500+ third-party apps during Work generation.

Plugin metadata

FieldValue
IDcomposio
Categorypipeline
Capabilitiespipeline, form-schema-provider
AuthorEver Works Team
LicenseAGPL-3.0
Built-inyes
Auto-enableno

What does the Composio plugin do?

This plugin lets Ever Works call any of Composio's 500+ third-party integrations (Gmail, Slack, GitHub, Notion, Linear, Salesforce, HubSpot, Stripe, Shopify, Airtable, …) during work generation. Composio brokers OAuth on your behalf — each user connects an app once through Composio's hosted flow, and the platform reuses that connection to execute tools.

Instead of writing a per-app connector for every service your users want to integrate, you ship one plugin (this one) and your users get the entire Composio catalog. The plugin invokes tools through the official @composio/core SDK (per Workspace AGENTS.md NN #22 — always use the official vendor SDK) and returns the result as pipeline outputs in one of three shapes: structured { items: [...] }, native records with a field mapping, or side-effect only (fire-and-forget).

Why use it?

  • Get 500+ integrations without writing connector code.
  • OAuth handled for you: Composio manages tokens, refresh, scopes, and rate limits.
  • Per-user accounts: every user connects their own Gmail / Slack / GitHub without sharing credentials.
  • Three execution shapes — structured items, native records via field mapping, or side-effect — to match different use cases.
  • Coexists with native Ever Works plugins (github, notion-extractor, …) — use the dedicated plugin where it exists, Composio for everything else.

How it works in Ever Works

When this plugin is selected as the active pipeline, the platform drives a Composio client from @composio/core through 6 sequential steps:

  1. Validate Composio Connection — composio.toolkits.get(...) confirms the API key is accepted, then composio.connectedAccounts.list({ userIds, toolkitSlugs }) confirms the user has an ACTIVE connected account for the requested toolkit.
  2. Prepare Tool Payload — builds the arguments object with work metadata, an optional existing-items summary, an optional GitHub data repository, and any user-supplied tool params.
  3. Execute Composio Tool — composio.tools.execute(toolSlug, { userId, arguments }). The SDK unwraps the v3 response envelope ({ successful, data, error, log_id }) for us.
  4. Collect & Validate Results — parses the response, projects records onto work items if needed, deduplicates against existing items.
  5. Capture Screenshots (optional) — uses the configured screenshot plugin to fetch images for items without them.
  6. Cleanup — releases resources.

The plugin treats the tool slug as the unique identifier of an action (GMAIL_SEND_EMAIL, GITHUB_CREATE_ISSUE, …). The toolkit slug is informational and used for connected-account validation.

Getting started

  1. Sign up at composio.dev and grab your API key from Settings → API Keys.
  2. Connect at least one toolkit (Gmail, GitHub, Slack, …) under your Composio user_id via the Composio dashboard.
  3. Open the Composio plugin settings in Ever Works and paste the API key. If the upstream account is connected under a different identifier (typically an email), set Default Composio User ID to that value.
  4. In the Generate flow, set the toolkit (e.g. GMAIL), the tool slug (e.g. GMAIL_SEND_EMAIL), the result shape, any custom tool arguments, then trigger a run.

Settings

  • apiKey (secret, required) — Composio API key, passed to the @composio/core SDK at construction time.
  • baseUrl — Override the Composio API base URL (leave empty for the default https://backend.composio.dev/api/v3).
  • defaultUserId — Composio user_id to run tools against. Defaults to your Ever Works user id.
  • defaultToolkit — Default toolkit slug (e.g. GMAIL).
  • defaultToolSlug — Default Composio tool slug (e.g. GMAIL_SEND_EMAIL).

The generator form additionally exposes per-run options including the toolkit, tool slug, Composio user id override, result shape, field mapping for native records, custom tool arguments, and tool timeout.

Result modes

  • Structured items — use when the tool already returns an items array that matches the work-item shape.
  • Native records — use when the tool returns raw records (Gmail messages, Notion pages, GitHub issues, …) and you want to map fields such as name, URL, description, category, tags, image, brand, or content.
  • Side-effect only — use when the tool should send a message, create a task, update another system, or trigger another workflow without adding work items.

Composio vs. native Ever Works plugins

Ever Works ships some native plugins (github, notion-extractor, …) that integrate directly with specific services. Composio gives you the rest of the catalog. They coexist: keep the native plugin for the apps it covers, and use Composio for everything else. The native plugin usually offers tighter integration (richer extraction, custom UI hints, OAuth via Ever Works' own callbacks); Composio offers breadth.

Troubleshooting

SymptomLikely causeFix
Generation never starts / stays at 0%composio not selected as the active pipeline plugin for this workOpen the work → Plugins → pipeline capability and set composio as the active pipeline; or set it as the global pipeline default in Settings → Plugins
Composio rejected the API key (HTTP 401/403)API key missing or invalidRegenerate at https://app.composio.dev/settings/api-keys and paste into plugin settings
No active Composio connected account found for user "..." on toolkit "..."The user has not connected the requested toolkit, or the connection is EXPIRED / REVOKEDOpen https://app.composio.dev/connections and complete (or re-initiate) the OAuth flow for the toolkit
Composio returned 404 for /tools/execute/...Tool slug is wrong or has been renamedBrowse https://app.composio.dev/tools to find the current slug; tool slugs are uppercase and toolkit-prefixed
Tool succeeds but returns no itemsTool returns native records, not structured itemsSwitch Result Shape to "Native records" and set the field mapping (at minimum name_field)

Local development

This plugin ships built-in with the Ever Works platform. To work on it locally from the monorepo root:

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

Documentation

License

AGPL-3.0

版本与发布记录

@ever-works/composio-plugin 共发布 15 个版本,首次发布于 2026/06/06;过去 12 个月发布了 15 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.0.18latest2026/11/0310 天前
1.0.172026/10/2817 天前
1.0.162026/10/2717 天前
1.0.152026/10/2717 天前
1.0.142026/10/2420 天前
1.0.132026/10/2025 天前

关于 @ever-works/composio-plugin 的常见问题

@ever-works/composio-plugin 是什么?

Composio Integration Plugin - Brokers OAuth and tool execution across 500+ apps via composio.dev

如何安装 @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 和提交记录判断。