mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-20 18:26:40 +01:00
## Thinking Path
> - Paperclip is the open source app people use to manage AI agents for
work.
> - Agents reach external apps through MCP connections. Paperclip
records each call and shows it as a tool row in the task chat.
> - MCP Apps (SEP-1865, extension `io.modelcontextprotocol/ui`, spec
2026-01-26) lets an MCP server attach an interactive `ui://` view to a
tool. Claude, Claude Code and VS Code render these views in chat.
Circleback uses them to show meeting cards.
> - Paperclip dropped the tool's `_meta.ui` at discovery and the
result's `_meta` at call time. Its gateway reported MCP App UI as
"unsupported". Circleback was reachable only through Composio, whose
toolkit has no `Display*` tools.
> - This pull request makes Paperclip an MCP Apps host. It also adds
Circleback as a native catalog connection.
> - The benefit is that a Circleback recap in a task shows the same
meeting cards as in Claude, and any other MCP server with views works
the same way.
## Linked Issues or Issue Description
**Subsystem affected**
Connections and apps (remote MCP gateway) and the task chat.
**Problem or motivation**
An agent that uses Circleback in Paperclip can only return text. The
same tools in Claude Code show interactive meeting cards
(`DisplayMeetings`). Paperclip discards the MCP Apps metadata, so it
cannot show them.
**Proposed solution**
Paperclip implements the host side of MCP Apps end to end. It keeps the
tool's view declaration and records each call that has a view. It
renders the view under the tool row in a sandboxed iframe that uses the
MCP Apps postMessage protocol. Circleback becomes a native catalog
connection, so its `Display*` tools are available.
**Alternatives considered**
Composio's `circleback_mcp` toolkit has 11 read tools and no `Display*`
tools, and its meta-tools return plain JSON, so it cannot carry views.
The spec's double-iframe sandbox proxy on a separate origin needs a
second origin that Paperclip does not have. A single opaque-origin
`srcdoc` frame with an injected CSP gives the same isolation.
**Roadmap alignment**
This extends the existing Apps catalog and MCP gateway. It adds no new
integration substrate (decision D4 in doc/connections/README.md).
**Additional context**
The standard, the design and the testing plan are in
`doc/connections/MCP-APPS.md`.
## What Changed
- **Shared:** `packages/shared/src/mcp-apps.ts` adds MCP Apps types,
`_meta.ui` and resource parsing (current and legacy keys), and a CSP
builder that keeps only well-formed `https` origins.
- **DB:** migration `0471` (`online_compatible`) adds
`tool_catalog_entries.ui_meta` and a new `tool_mcp_app_views` table.
- **Server, catalog:** discovery keeps each tool's `_meta.ui`. It is not
part of the version hash, so a view never quarantines a reviewed tool.
- **Server, gateway:**
- Paperclip advertises the MCP Apps client capability when it
initializes a session.
- App-only tools (`visibility: ["app"]`) are hidden from agents.
- The result `_meta` is kept for the view and is not sent to the agent.
- Each successful call to a tool with a view records a view row.
Recording is best effort.
- The gateway's `initialize` now reports `paperclip/mcp-app-ui:
host_rendered`.
- The context protocol (`resources/read`) now uses the injected test
transport, like the other remote calls.
- **Server, routes:** `server/src/routes/mcp-apps.ts`
- `GET /api/issues/:issueId/mcp-app-views` lists a task's views. It
needs task read access.
- `GET /api/issues/:issueId/mcp-app-views/:viewId` returns the view
document, read live through the agent's connection.
- `POST /api/issues/:issueId/mcp-app-views/:viewId/tool-calls` runs the
view's `tools/call`. It needs `tools:use` and reaches only tools of the
same connection that allow `app`. It uses the connection test-call path,
so policy, Ask first and audit apply.
- **UI:** `ui/src/components/mcp-app/`
- The host protocol: `ui/initialize` with theme, style variables and
size limits; tool-input; tool-result; size-changed; `tools/call`;
`ui/open-link` (http and https only); teardown.
- An opaque-origin iframe (`allow-scripts`, never `allow-same-origin`)
with the CSP placed before the view's markup.
- The views of a run render with that run's reply, in the live turn and
in settled history. They are keyed by the reply's run, so history needs
no transcript.
- **Circleback:** a native catalog app (`mcp-oauth`, DCR, `user
user:write`) with:
- the official logo;
- a reviewed risk classifier (Share* tools are writes, Delete* tools are
destructive, Display* tools are reads);
- warnings in the sign-in step;
- `doc/connections/CIRCLEBACK.md`.
Search now prefers a native app over an aggregator listing named "X
MCP".
- **Storybook:** `Tasks/MCP App views` shows the tool row with its view,
the ready state (Refresh calls a tool), loading, view unavailable, and a
tool call that needs approval.
## Verification
- `pnpm exec vitest run packages/shared/src/mcp-apps.test.ts
ui/src/components/mcp-app/`: 19 passed.
- `pnpm exec vitest run server/src/__tests__/mcp-apps.test.ts`: 3
passed, on embedded Postgres. The test connects Circleback through the
catalog with DCR OAuth against a fake Circleback MCP server. It checks:
- `ui_meta` is stored;
- an app-only tool is hidden from the agent;
- an agent call records one view with arguments, structured content and
`_meta`;
- a call without a view records nothing;
- the routes serve the view's HTML and CSP;
- the view's tool call works and a model-only tool is refused;
- another task, another company and an agent actor are refused.
- Circleback connector: 13 focused files, 645 tests passed. These are
the app definitions, search, aggregator fallback, connection intents,
tool policy, `AppsConnect` and `Browse`.
- Typecheck passed for `@paperclipai/shared`, `@paperclipai/server` and
`@paperclipai/ui`. `node scripts/storybook-catalog.mjs` and the
migration compatibility check also passed.
- Storybook check in the browser:
- In both themes, the view runs the handshake, renders the meeting cards
from `structuredContent`, picks up the theme variables, and resizes to
its content.
- Refresh sends `tools/call` and re-renders the cards.
- **Live Circleback end to end** on a local instance, with a real
Circleback account:
- Connected through the catalog entry with Circleback's dynamic client
registration and OAuth.
- Discovery stored the real view declarations:
- `DisplayMeetings` uses `ui://circleback/meetings.v2.html`.
- `DisplayActionItems` and `DisplayCalendarEvents` also have views.
- `ListAssigneeOptions` and `SetCalendarEventRecording` are app-only
helpers with no view. They are hidden from agents.
- A `claude_local` agent called `DisplayMeetings` on two tasks.
- The real 3.5 MB Circleback view rendered the meeting cards with the
agent's reply.
- Clicking a card opened that meeting in Circleback through
`ui/open-link`.
- The live run found two bugs, both fixed in this PR, each with a
regression test:
- The 1 MB tool-result limit blocked the view document.
- Views were hidden inside the folded tool history.
## Risks
- **New migration:** a new table and a nullable column. It is
`online_compatible`.
- **Existing connections:** tools get `ui_meta` on the next catalog
refresh. Until then, no view shows and the tool row is unchanged.
- **Untrusted provider HTML:** the view runs as provider HTML in an
opaque-origin sandbox. It cannot reach Paperclip's session, DOM or API.
Its network access is limited to the origins its server declared. A
view's tool calls use the viewer's permissions and the normal policy and
Ask-first path.
- **Agent tool lists:** app-only tools are removed from them. No current
provider marks tools app-only, so no listed tool disappears.
- **Search:** the change that prefers a native app over an "X MCP"
aggregator listing affects every app.
## Model Used
- Claude Opus 5.5 (`claude-opus-5-5`) in Claude Code, with tool use and
subagents (one subagent authored the Circleback catalog connector).
## 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
- [ ] 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>
191 lines
6.4 KiB
TypeScript
191 lines
6.4 KiB
TypeScript
/**
|
|
* Prosumer copy for the Apps surface (PAP-10856).
|
|
*
|
|
* The P1a gallery manifest carries developer-flavoured taglines and credential
|
|
* labels (e.g. "Connect Zapier-hosted MCP actions", "Zapier MCP token"). Those
|
|
* strings would fail the vocabulary gate from PAP-10827 — no "MCP", "server",
|
|
* "profile", "policy", "gateway", or "transport" anywhere on this surface. So
|
|
* the UI never renders the raw manifest copy directly: it looks up plain copy
|
|
* here, and `sanitizeProsumerCopy` is a final backstop for any free-text we do
|
|
* surface (app names, fallback taglines).
|
|
*/
|
|
|
|
/** Words that must never appear in prosumer-facing copy on the Apps surface. */
|
|
const BANNED_WORDS = [
|
|
"mcp",
|
|
"server",
|
|
"profile",
|
|
"policy",
|
|
"gateway",
|
|
"transport",
|
|
"stdio",
|
|
"endpoint",
|
|
];
|
|
|
|
const BANNED_RE = new RegExp(`\\b(${BANNED_WORDS.join("|")})s?\\b`, "gi");
|
|
|
|
/**
|
|
* Strip banned vocabulary from a free-text string as a last-resort backstop.
|
|
* Prefer curated copy below; this only protects against manifest text we can't
|
|
* fully control (e.g. a newly added gallery app with no curated entry yet).
|
|
*/
|
|
export function sanitizeProsumerCopy(text: string): string {
|
|
return text
|
|
.replace(BANNED_RE, "")
|
|
.replace(/\s{2,}/g, " ")
|
|
.replace(/\s+([.,])/g, "$1")
|
|
.trim();
|
|
}
|
|
|
|
export interface AppCopy {
|
|
/** Two short lines for the gallery card (M2). */
|
|
tagline: string;
|
|
/** Single line for the connect step header (M3b). */
|
|
short: string;
|
|
}
|
|
|
|
/**
|
|
* Curated prosumer copy keyed by gallery key. Taken from the M-series wires
|
|
* (https://happy-grove-jzyc.here.now/). Apps without an entry fall back to a
|
|
* generic, gate-safe line.
|
|
*/
|
|
const APP_COPY: Record<string, AppCopy> = {
|
|
zapier: {
|
|
tagline: "Reach 9,000+ apps your team already uses.",
|
|
short: "Reach 9,000+ apps from your agents.",
|
|
},
|
|
github: {
|
|
tagline: "Read code and pull requests, comment on issues.",
|
|
short: "Read code and pull requests, comment on issues.",
|
|
},
|
|
slack: {
|
|
tagline: "Send and read messages in your team's channels.",
|
|
short: "Send and read messages in your channels.",
|
|
},
|
|
notion: {
|
|
tagline: "Read and update pages in your workspace.",
|
|
short: "Read and update pages in your workspace.",
|
|
},
|
|
railway: {
|
|
tagline: "Inspect services, read logs, and manage deployments.",
|
|
short: "Connect Railway for deployments, logs, and container access.",
|
|
},
|
|
posthog: {
|
|
tagline: "Explore product usage, errors, flags, and experiments.",
|
|
short: "Sign in with PostHog. Project pinning and access controls are optional.",
|
|
},
|
|
ditto: {
|
|
tagline: "Reuse approved product copy and follow your style guide.",
|
|
short: "Sign in with Ditto. API keys are optional.",
|
|
},
|
|
circleback: {
|
|
tagline: "Search meeting notes, transcripts, and action items.",
|
|
short: "Sign in with Circleback. Meetings appear as cards in chat.",
|
|
},
|
|
gauge: {
|
|
tagline: "Track your brand in AI answers and run content workflows.",
|
|
short: "Sign in with Gauge and pick an organization. API keys are optional.",
|
|
},
|
|
neon: {
|
|
tagline: "Manage Postgres projects, branches, and queries.",
|
|
short: "Sign in with Neon. Project pinning and read-only mode are optional.",
|
|
},
|
|
superagent: {
|
|
tagline: "Review security findings and run red-team checks.",
|
|
short: "Connect with a Superagent API key. Billable and destructive tools stay under action policies.",
|
|
},
|
|
linear: {
|
|
tagline: "Create, update and read tickets.",
|
|
short: "Create, update and read tickets.",
|
|
},
|
|
"google-sheets": {
|
|
tagline: "Read and update selected spreadsheets.",
|
|
short: "Read spreadsheets or update the files you choose.",
|
|
},
|
|
gmail: {
|
|
tagline: "Read mail and create drafts for your review.",
|
|
short: "Read mail and create drafts for your review.",
|
|
},
|
|
"google-drive": {
|
|
tagline: "Find, read, and create files in Drive.",
|
|
short: "Find, read, and create files in Drive.",
|
|
},
|
|
"google-docs": {
|
|
tagline: "Read and update documents.",
|
|
short: "Read and update documents.",
|
|
},
|
|
"google-slides": {
|
|
tagline: "Read and update presentations.",
|
|
short: "Read and update presentations.",
|
|
},
|
|
"google-calendar": {
|
|
tagline: "Review calendars and manage events.",
|
|
short: "Review calendars and manage events.",
|
|
},
|
|
"google-chat": {
|
|
tagline: "Read conversations and send messages.",
|
|
short: "Read conversations and send messages.",
|
|
},
|
|
"google-people": {
|
|
tagline: "Look up contacts and people in your directory.",
|
|
short: "Look up contacts and people in your directory.",
|
|
},
|
|
"google-workspace-search": {
|
|
tagline: "Search across your Google workspace.",
|
|
short: "Search across your Google workspace.",
|
|
},
|
|
hubspot: {
|
|
tagline: "Look up contacts and update deal stages.",
|
|
short: "Look up contacts and update deal stages.",
|
|
},
|
|
intercom: {
|
|
tagline: "Read and reply to customer conversations.",
|
|
short: "Read and reply to customer conversations.",
|
|
},
|
|
figma: {
|
|
tagline: "Read files and post comments on frames.",
|
|
short: "Read files and post comments on frames.",
|
|
},
|
|
stripe: {
|
|
tagline: "Read customers, invoices, and payouts.",
|
|
short: "Read customers, invoices, and payouts.",
|
|
},
|
|
context7: {
|
|
tagline: "Look up up-to-date docs for your libraries.",
|
|
short: "Look up up-to-date docs for your libraries.",
|
|
},
|
|
};
|
|
|
|
const GENERIC: AppCopy = {
|
|
tagline: "Give your agents access to this app.",
|
|
short: "Give your agents access to this app.",
|
|
};
|
|
|
|
/** Curated, gate-safe copy for a gallery app. */
|
|
export function appCopyFor(key: string, fallbackTagline?: string | null): AppCopy {
|
|
const curated = APP_COPY[key];
|
|
if (curated) return curated;
|
|
if (fallbackTagline) {
|
|
const cleaned = sanitizeProsumerCopy(fallbackTagline);
|
|
if (cleaned) return { tagline: cleaned, short: cleaned };
|
|
}
|
|
return GENERIC;
|
|
}
|
|
|
|
/**
|
|
* Label for a single credential field on the key-paste step (M3b). The raw
|
|
* manifest label can contain banned vocab ("Zapier MCP token"), so for the
|
|
* common single-field case we present "Your {App} key" per the wires; multi-
|
|
* field apps fall back to a sanitized version of the manifest label.
|
|
*/
|
|
export function credentialFieldLabel(
|
|
appName: string,
|
|
rawLabel: string,
|
|
fieldCount: number,
|
|
): string {
|
|
if (/^Paste your\b/.test(rawLabel)) return sanitizeProsumerCopy(rawLabel);
|
|
if (fieldCount <= 1) return `Your ${appName} key`;
|
|
const cleaned = sanitizeProsumerCopy(rawLabel);
|
|
return cleaned || `Your ${appName} key`;
|
|
}
|