@ever-works/sim-ai-plugin

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

SIM AI Workflow Pipeline Plugin - Delegates Work generation to SIM AI workflows

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

@ever-works/sim-ai-plugin

SIM AI Workflow Pipeline Plugin - Delegates Work generation to SIM AI workflows

Plugin metadata

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

What does the Sim AI plugin do?

This plugin lets Ever Works delegate the work-generation pipeline to Sim AI, an open-source AI agent workflow builder. Instead of running the built-in pipeline, Ever Works hands each generation request off to a deployed Sim workflow that you design visually in the Sim builder.

You author a workflow in Sim, deploy it, and generate an API key for it. The plugin (using the official simstudio-ts-sdk) executes that workflow during work generation, passing in the work context, the request, and a summary of existing items. The workflow runs in Sim — optionally chaining LLM agents, tool calls, search APIs, and custom logic — and returns structured JSON that Ever Works converts into pipeline outputs (the work draft, items list, categories, tags, brands).

Why use it?

  • Build multi-step AI agent workflows visually without managing your own orchestration layer.
  • Compose AI providers, tools, and custom blocks inside Sim's agent-native workflow editor.
  • Self-host Sim or use the hosted offering — your choice of deployment model.
  • Swap in custom logic, change models, or add tool calls without touching Ever Works code.
  • Reuse the same Sim workflows across Ever Works and other applications via the Sim SDK.

How it works in Ever Works

When this plugin is selected as the active pipeline, the platform sends each generation request to Sim through the official Sim Studio TypeScript SDK, identifying the workflow by ID and authenticating with your API key. The workflow runs in Sim — optionally calling AI providers, search APIs, tools, etc. — and the plugin polls until completion, then collects the structured JSON response. That response is parsed back into Ever Works pipeline outputs (the work draft, items list, categories, tags). The required output schema is documented in the Ever Works docs.

Getting started

  1. Sign up at sim.ai (or self-host Sim) and create a new workflow in the builder.
  2. Deploy the workflow and generate an API key for it from the deployment dialog.
  3. Copy the workflow ID from the Sim dashboard.
  4. Open the Sim AI plugin settings in Ever Works, paste the API key, the workflow ID as the default workflow, and (optionally) a custom base URL if you are self-hosting Sim. Save.
  5. Trigger a run from the Generate flow.

Settings

  • apiKey (secret) — Sim API key generated when deploying the workflow. Required.
  • baseUrl — Custom Sim instance URL. Leave empty to use the default Sim cloud endpoint.
  • defaultWorkflowId — Default Sim workflow to invoke when not specified in the generator form. Required.

The generator form additionally exposes per-run options including a workflow ID override, target item count, workflow timeout, repository access pass-through, and screenshot capture.

Troubleshooting

SymptomLikely causeFix
Generation never starts / stays at 0%sim-ai not selected as the active pipeline plugin for this workOpen the work → Plugins → pipeline capability and set sim-ai as the active pipeline; or set it as the global pipeline default in Settings → Plugins
Step fails with No AI / search / screenshot provider configuredPipeline depends on capability plugins that are not enabled or have no credentialsEnable and configure the matching capability plugin (AI provider, search, screenshot, content-extractor) for the work or globally
Step output looks wrong / genericForm-field tuning not set; pipeline using defaults that don't match the work's domainOpen the Generator Form for the work, set domain-specific fields (categories, target keywords, source URLs), and re-run the affected step
Webhook returns 404 / Not FoundScenario / Zap not enabled or webhook URL staleIn the SIM AI Workflows dashboard verify the scenario is active, copy a fresh webhook URL into the plugin settings, and trigger a test run
Pipeline cannot resume after host restartCheckpoint not persisted (only the standard pipeline persists checkpoints today)Cancel the stuck run and re-trigger generation; for production reliability prefer standard-pipeline

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/sim-ai-plugin build
pnpm --filter @ever-works/sim-ai-plugin test

Documentation

License

AGPL-3.0

版本与发布记录

@ever-works/sim-ai-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/sim-ai-plugin 的常见问题

@ever-works/sim-ai-plugin 是什么?

SIM AI Workflow Pipeline Plugin - Delegates Work generation to SIM AI workflows

如何安装 @ever-works/sim-ai-plugin?

在项目目录运行 npm install @ever-works/sim-ai-plugin,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@ever-works/plugin(^1.2.16)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@ever-works/sim-ai-plugin 支持 TypeScript 吗?

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

@ever-works/sim-ai-plugin 支持 ESM 还是 CommonJS?

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

@ever-works/sim-ai-plugin 可以商用吗?

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

@ever-works/sim-ai-plugin 的下载量有多少?

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

@ever-works/sim-ai-plugin 还在维护吗?

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