Files
PaperClipAI/server/src/services/plugin-connector-legacy-access.ts
T
DottaandClaude Opus 5.5 f4cb69205e Let plugin workers serve connector tools (plugin transport) (#22019)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work
> - Plugins can now add connector types to the Connectors catalog
(#22004), but only for transports the host already runs (remote MCP,
local stdio)
> - A plugin cannot yet serve a connector's tools itself, and legacy
plugin tools (top-level manifest `tools`) still reach every agent
without a connection or install
> - A plugin should be able to ship a full connector: settings,
credentials, tools, grants, policies and audit, like a built-in one
> - This pull request adds the `plugin` transport, the SDK API to serve
it, and moves legacy plugin tools under the same activation rules
without changing today's access
> - The benefit is that any connector can live in a plugin, and agents
get plugin tools only when an operator enables them

## Linked Issues or Issue Description

Refs #22004

**Subsystem affected**
Plugins (SDK, worker protocol, manifest), Connectors (tool access,
catalog discovery), tool gateway, database.

**Problem or motivation**
A plugin connector can only describe an existing transport. There is no
way for a plugin worker to serve a connector's tools with per-connection
settings and credentials. Legacy plugin tools are visible to every agent
as soon as the plugin is enabled, which is the opposite of the connector
activation rules.

**Proposed solution**
Add a `plugin` transport. The gateway keeps every decision (grant,
policy, approval, rate limit, audit) and calls the plugin worker with
the connection, its settings and a per-call credential. Legacy top-level
tools become one implicit connector per plugin. Existing installations
keep exactly their current access through a one-time migration.

**Alternatives considered**
Move legacy tools to connection tool names (`app.<connection>:<tool>`).
Rejected: names change, so existing tool policies and agent instructions
that name `plugin:tool` would stop matching (a possible widening or
loss). Legacy tools keep their names and handlers; only their visibility
is now gated by an install of the implicit connector.

## What Changed

- `packages/db`: migration `0491` widens
`tool_connections_transport_check` with `plugin` (`NOT VALID`, annotated
`online_compatible`), and adds `plugin_connector_legacy_access`, seeded
with one row per installed legacy-tools plugin and company.
- `packages/shared`: method schema gains `settingsSchema` and `tools`
(`{ kind: "static", list: [{ name, displayName?, description?, risk,
parametersSchema }] } | { kind: "dynamic" }`), only for `transport:
"plugin"`; tool names must match `[a-z0-9_]`; plugin-served methods use
`none` or `api_key`. The connect API accepts `settings`.
- `packages/plugins/sdk`: `ToolRunContext.connection` (`id`, `appSlug`,
`methodKey`, `grantId`, `settings`, `credential?`);
`ctx.connectors.register(appSlug, toolName, fn)` and
`ctx.connectors.listTools(appSlug, fn)`; new `listConnectorTools` RPC;
`executeTool` routes connector calls by `appSlug`. A worker refuses to
start when a declared static tool (or dynamic lister) has no handler.
The test harness gains `executeConnectorTool` and `listConnectorTools`.
- `server/src/services/plugin-connector-runtime.ts`: routes one call to
the plugin's worker; a stopped worker is a
`PluginWorkerUnavailableError`.
- Connect flow (`tool-access.ts`): a `plugin` method creates a
`paperclip_plugin` application and a `plugin` connection with `config =
{ sourceTemplateKey, connectionMethodKey, settings }`, validated against
`settingsSchema`. Credentials, grants, credential policy, installs and
profiles use the existing code.
- Catalog: static tools come from the definition, dynamic tools from
`listConnectorTools`, with the existing version hashing and retirement.
Tool risk comes from the declaration.
- Gateway: plugin connections join connected-tool discovery and both
execution paths (direct and approved actions). For each call the gateway
resolves the grant and, for `api_key`, the credential for that call
only. The run context comes only from the session. A stopped worker
returns `503 plugin_connector_unavailable` with `retryable: true`. The
token broker refuses to export plugin connector credentials.
- Legacy tools: a plugin with top-level `tools` and no `apps` gets an
implicit connector (slug `default`, named after the plugin, no
authentication). Its tools keep their names, handlers and today's access
decision, and an agent sees them only when a connection of that
connector is installed for it or for the company. The connector's saved
action rules (Off, Ask first) can only restrict them.
`completeLegacyPluginToolAccess` turns each migration row into such a
connection with a company install, at boot and when a disabled plugin is
enabled again; it is single-flight across servers, resumes a draft left
by an interrupted attempt, and never overrides an operator's later
changes.
- Catalog: tools a dynamic connector stops offering are retired from
discovery; `listConnectorTools` carries the connection's `companyId`,
and uses the acting person's grant for personal connections.
- Board: the setup flow renders `settingsSchema` with the shared JSON
Schema form, sends `settings`, and restores saved settings on resume and
reconnect.
- `create-paperclip-plugin --template connector` now scaffolds a plugin
connector (`apps` + `ctx.connectors.register` + a harness test). SDK
README and `PLUGIN_SPEC.md` describe connectors; top-level `tools` stay
documented as legacy.
- `inferToolRisk` moves to `tool-risk-inference.ts` so the catalog can
reuse it.

Design notes where the spec left room:
- OAuth for `plugin`-transport methods is not supported in this PR
(`none` and `api_key` only); OAuth plugin connectors can use
`mcp_remote` today. Noted as follow-up.
- Board "Test" calls on a plugin connection pass an empty
`agentId`/`runId`, because there is no agent run.
- Companies created after the upgrade get no automatic legacy
connection; they follow the normal activation rules.

## Verification

- `server`: `npx vitest run
src/__tests__/plugin-connectors-plugin-transport.test.ts` (new):
- rules 1-3: a ready plugin and configured accounts give no tools; an
install for agent A gives only A the tools; agent B is denied on
invocation;
- the worker receives `runContext.connection` with the right id, method,
grant, settings and the call's credential; spoofed arguments do not
change it; each account calls with its own key; results do not contain
the key;
- invalid settings are rejected (422); a stopped worker is `503
plugin_connector_unavailable` (retryable); a disabled plugin hides the
tools;
- dynamic tools are listed through the worker and a tool it stops
offering is retired;
- rule 5: a new installation of a legacy-tools plugin gives no tools; an
installation recorded by the migration keeps the same tool names for
every agent, through one company-wide connection (two concurrent
carry-overs make one; an interrupted draft is finished; a retry keeps an
operator's restriction), and is not also exposed as connection tools;
Ask first and Off on the implicit connector restrict the legacy tools;
  - the token broker refuses to export a plugin connection's credential.
- Existing gateway plugin-tool tests (`tool-gateway`,
`tool-gateway-service`, `prompt-injection-gateway`) now set up the
legacy grant an existing installation has, and pass unchanged otherwise.
- Regression: `plugin-connectors-circleback-parity`, `tool-gateway`,
`tool-gateway-service`, `prompt-injection-gateway`,
`tool-access-service` (846 passed), plus `connector-tool-policy`,
`plugin-lifecycle-restart`, `remote-mcp-connectors`,
`ai-connection-router` in an earlier run.
- UI: `AppsConnect.test.tsx` covers sending plugin settings from the
settings schema.
- SDK: `tests/worker-rpc-host.test.ts` (start refusal without handlers,
connector routing, tool listing). Scaffold: `entrypoints.test.ts`.
- `packages/db`: `pnpm typecheck` including `check:migrations`; server
layered typecheck (sources and tests); `tsc --noEmit` for shared, SDK,
scaffold and UI.

## Risks

- Behavior change for new installations: legacy plugin tools no longer
reach agents until an operator connects the plugin's connector.
Installations that exist at upgrade time keep their tools through the
migration rows.
- The migration widens a check constraint (`NOT VALID`) and copies
plugin × company rows into a new table. Both are fast; the previous
release never writes `plugin`.
- Calls depend on the plugin worker; when it is down the agent gets a
retryable error.

> For core feature work, check [`ROADMAP.md`](ROADMAP.md) first and
discuss it in `#dev` before opening the PR. Feature PRs that overlap
with planned core work may need to be redirected — check the roadmap
first. See `CONTRIBUTING.md`.

## Model Used

- Claude Opus 5.5 (`claude-opus-5-5`), Anthropic, used through Claude
Code with tool use (shell, file editing, test execution).

## Checklist

- [x] I have included a thinking path that traces from project context
to this change
- [x] I have specified the model used (with version and capability
details)
- [x] I have checked ROADMAP.md and confirmed this PR does not duplicate
planned core work
- [x] I have searched GitHub for duplicate or related PRs and linked
them above
- [x] I have either (a) linked existing issues with `Fixes: #` / `Closes
#` / `Refs #` OR (b) described the issue in-PR following the relevant
issue template
- [x] I have not referenced internal/instance-local Paperclip issues or
links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip`
URLs)
- [x] My branch name describes the change (e.g. `docs/...`, `fix/...`)
and contains no internal Paperclip ticket id or instance-derived details
- [x] I have run tests locally and they pass
- [x] I have added or updated tests where applicable
- [x] I have updated relevant documentation to reflect my changes
- [x] I have considered and documented any risks above
- [ ] All Paperclip CI gates are green
- [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups
- [x] I will address all Greptile and reviewer comments before
requesting merge

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-17 18:09:42 +00:00

98 lines
4.7 KiB
TypeScript

/**
* Keeps today's agent access to legacy plugin tools.
*
* Before plugin connectors, every agent could use the tools a plugin declared
* with the top-level manifest `tools`. Those tools now belong to the plugin's
* implicit connector, and an agent gets them only from a connection installed
* for it or for the whole company. The migration that introduced connectors
* recorded each plugin installed at that time, per company, in
* `plugin_connector_legacy_access`. This job turns each pending row into one
* connection of the implicit connector, installed for the whole company, so
* those agents keep exactly the tools they had. Plugins installed later have
* no row and follow the normal activation rules.
*
* A row stays pending while its plugin is not ready (for example disabled)
* or its worker is down, and is completed the next time the worker starts.
*/
import { and, eq, isNull, lt, ne, or, sql } from "drizzle-orm";
import { pluginConnectorLegacyAccess, toolConnections, type Db } from "@paperclipai/db";
import { pluginAppSlug } from "@paperclipai/shared";
import { logger } from "../middleware/logger.js";
import { LEGACY_PLUGIN_TOOLS_APP_SLUG, loadPluginAppCatalog } from "./plugin-app-catalog.js";
/** A claim older than this belongs to a server that stopped mid-way. */
const STALE_CLAIM_MS = 10 * 60_000;
/**
* Turn pending rows into connections. Each row is claimed first, so servers
* sharing the database never work on the same row; a failed row is released
* and retried the next time the plugin's worker starts (boot, enable,
* upgrade, reload or restart).
*/
export async function completeLegacyPluginToolAccess(db: Db, pluginKey?: string): Promise<number> {
const pending = await db
.select()
.from(pluginConnectorLegacyAccess)
.where(and(
isNull(pluginConnectorLegacyAccess.completedAt),
pluginKey ? eq(pluginConnectorLegacyAccess.pluginKey, pluginKey) : undefined,
));
if (pending.length === 0) return 0;
const catalog = await loadPluginAppCatalog(db);
const { toolAccessService } = await import("./tool-access.js");
const access = toolAccessService(db);
let completed = 0;
for (const row of pending) {
const slug = pluginAppSlug(row.pluginKey, LEGACY_PLUGIN_TOOLS_APP_SLUG);
if (!catalog.definitions.some((candidate) => candidate.slug === slug)) continue;
const [claimed] = await db
.update(pluginConnectorLegacyAccess)
.set({ claimedAt: new Date() })
.where(and(
eq(pluginConnectorLegacyAccess.id, row.id),
isNull(pluginConnectorLegacyAccess.completedAt),
or(
isNull(pluginConnectorLegacyAccess.claimedAt),
lt(pluginConnectorLegacyAccess.claimedAt, new Date(Date.now() - STALE_CLAIM_MS)),
),
))
.returning({ id: pluginConnectorLegacyAccess.id });
if (!claimed) continue;
try {
// A retry after the connection was made but before completion was
// recorded finishes that same connection instead of adding another.
const [existing] = await db.select({ id: toolConnections.id, status: toolConnections.status }).from(toolConnections).where(and(
eq(toolConnections.companyId, row.companyId),
ne(toolConnections.status, "archived"),
sql`${toolConnections.config}->>'sourceTemplateKey' = ${slug}`,
sql`${toolConnections.config}->>'legacyPluginTools' = 'true'`,
)).limit(1);
const connectionId = existing?.id ?? (await access.connectGalleryApp(row.companyId, {
galleryKey: slug,
connectionMethodKey: LEGACY_PLUGIN_TOOLS_APP_SLUG,
})).connectionId;
// Finish a new connection, or a draft an interrupted attempt left. An
// active connection is already configured (perhaps restricted by an
// operator since); keep its saved permissions as they are.
if (!existing || existing.status === "draft") {
const entries = await access.listCatalog(connectionId);
await access.finishGalleryAppConnection(row.companyId, connectionId, {
enabledCatalogEntryIds: entries.filter((entry) => entry.status === "active").map((entry) => entry.id),
askFirstCatalogEntryIds: [],
access: "all_agents",
});
}
await db
.update(pluginConnectorLegacyAccess)
.set({ connectionId, completedAt: new Date(), claimedAt: null })
.where(eq(pluginConnectorLegacyAccess.id, row.id));
completed += 1;
} catch (error) {
await db.update(pluginConnectorLegacyAccess).set({ claimedAt: null }).where(eq(pluginConnectorLegacyAccess.id, row.id))
.catch(() => undefined);
logger.warn({ err: error, pluginKey: row.pluginKey, companyId: row.companyId }, "Could not keep legacy plugin tool access");
}
}
return completed;
}