Files
PaperClipAI/server/src/__tests__/heartbeat-runtime-mcp-servers.test.ts
T
Nicky LeachandClaude Opus 5.5 11ac90e31f fix(build): typecheck server/src/__tests__ and fix every type error (#18739)
## Thinking Path

> - Paperclip is the open source app people use to manage AI agents for
work
> - The server has about 1,100 test and helper files in
`server/src/__tests__`
> - `server/tsconfig.json` excludes that directory, Vitest does not
check types, and no script runs the tsconfig in that directory
> - So a test can call a function with the wrong arguments and still
pass, and no tool reports it
> - This gap hid 2,168 real type errors, and some of them hid tests that
did not test what they claim
> - This pull request fixes all of these errors and adds the directory
to the server layers from paperclipai/paperclip#18737
> - The benefit is that a type error in a server test now fails the
typecheck, with no baseline and no backlog

## Linked Issues or Issue Description

Refs paperclipai/paperclip#18737, which is merged and added the server
layers. Refs paperclipai/paperclip#18738, which is merged and checks the
test projects outside `pnpm -r`, so it is not a duplicate. Refs
paperclipai/paperclip#18137, which records that this directory has no
check.

**What happened?**

No tool checked the types of 1,074 of the 1,101 files in
`server/src/__tests__`. I searched `package.json`, the workflows, and
all tsconfig files. 27 files are in the program of another tsconfig, and
these 27 have 0 errors. 11 of the 27 are in
`helpers/maintenance/tsconfig.json`. No script ran that project when I
measured this. paperclipai/paperclip#18738 now runs it.

**Expected behavior**

The server typecheck checks these files, and a type error fails the
check.

**Steps to reproduce**

1. On the base commit, run `tsc -p server/src/__tests__/tsconfig.json
--noEmit`. It reports 6,536 errors and needs 12.3 GiB.
2. Add a type error to any file in `server/src/__tests__`.
3. Run `pnpm --filter @paperclipai/server typecheck`. It passes.

**Paperclip version or commit**

I measured the error breakdown below on commit `8dfd632452`, with
TypeScript 7.0.2. The branch now includes master up to
paperclipai/paperclip#18865.

**Deployment mode**

Not applicable. This issue applies to development and CI. No production
source file in the server changes.

### Error breakdown

Each row adds one change to the row above.

| Step | Total errors | Change | Cause |
| --- | --- | --- | --- |
| Config as committed | 6,536 | | |
| Add `src/types/*.d.ts` | 4,447 | -2,089 | Config. The Express request
types were missing. |
| Set `rootDir` to the repository root | 2,436 | -2,011 | Config. |
| Set `allowImportingTsExtensions` | 2,181 | -255 | Config. Vitest
accepts `.ts` imports. |
| Add `ES2024.Promise` to `lib` | 2,138 | -43 | Config. Node 24 has
`Promise.withResolvers`. |
| Set `allowJs` for `.mjs` imports | 2,148 | +10 | Config. It removes 8
`TS7016` errors and shows new real errors. |
| Set `declaration` to false | 2,142 | -6 | Config. Tests emit nothing.
|
| Count only files in `server/src` | 2,058 | -84 | Other packages: 53
Daytona, 29 Runner test, 2 UI. |

So 4,478 of the 6,536 errors (69%) came from config or scope, and 2,058
are real type errors in 314 files. The 29 Runner test errors are also
real, which gives 2,087 errors. Tests that master added after this
measurement had 81 more errors, so this pull request fixes 2,168 errors.

This table classifies the first 2,058 errors.

| Kind of real error | Errors |
| --- | --- |
| Wrong argument or assignment type | 1,023 |
| Stale or partial fixture objects | 525 |
| Property that the type does not have | 317 |
| Missing narrowing of null or unknown | 101 |
| Implicit any | 60 |
| Missing name or module | 16 |
| Other | 16 |

### What the type errors hid

Most errors were stale fixtures and loose mocks. These errors hid real
test problems, and this pull request fixes them:

- **A test that never ran.** `instrumentation.test.ts` required
`sdk-trace-base`, which is not installed. So 3 span tests were skipped.
They now run and pass.
- **Assertions that could not fail.**
- `issue-thread-interactions-service` used a company ID as an issue ID.
- `status-card-evaluation-work` compared `[]` with `[]` in a rollback
check.
- `slack-conversation-lifecycle` read `item.issueId`, which does not
exist.
  - `email-channels` used a permission key that does not exist.
- `heartbeat-project-env` imported `LOW_TRUST_REVIEW_PRESET`, which is
not exported. The value was undefined.
- **Postgres processes that did not stop.** 11 test files called `stop`
on the test database helper. That method does not exist, and the helper
method is `cleanup`.
- **Arguments that the service ignored.**
- `methodKey` is now `connectionMethodKey` in the Daytona, Unikraft,
1Password, and Railway tests.
- 108 calls passed `"owner-user"` to a parameter that expects an options
object.
- 9 chat wizard fixtures passed `managementContext` as `source`, so they
ran `existing_app` and not `manifest`.
  - 2 tests passed a `{ userId }` actor that the function ignores.
- Inserts into `environments` passed a `companyId` column that the table
does not have.
- **Problems in tests that master added during this work.**
- `sandbox-creation-operations` read `database.connectionString` when an
external test database was set. In that mode `database` is undefined, so
the fixture would stop with a TypeError. It now uses the external URL.
- `idle-completed-history` set a Dot operation to `dispatched`. That is
a Muse status, and the Dot type does not have it. The fixture now uses
`admitted`, which is a real in-flight Dot status.

### Possible product problems, not changed

These may be real problems in production code or types. I did not change
them, because this pull request does not change production behavior:

- `decisions-service` `service.create` does not validate the lenient
`cancel_issue_tree` input.
- `createConnection` ignores `input.connectionPurpose`.
- The `createConnection` route schema default stores `{}` for
`transportConfig`.
- `prepareManagedAiRuntime` accepted the invalid value `mode:
"connection"`.
- `createBinding` accepts invalid `projectionClass` strings outside
class 3.
- `ensureManagedProjectWorkspace` forwards an untyped `repoRef` by
spread.
- `routineVariableSchema.label` is optional, but `RoutineVariable.label`
is required.
- `ToolRunContext.projectId` may be too strict.
- `withdrawInteraction` reads `issue.status`, which its type omits.
- `issueService.list` and `reconcileNativeFinalizations` omit fields
that they return at runtime.
- `createGitHubExternalObjectProvider` handles `tokenProvider: null`,
but its type forbids this value.

## What Changed

- Fixed the 2,168 type errors. The diff changes 322 test and helper
files.
- Corrected `server/src/__tests__/tsconfig.json`. Editors and the
typecheck now read the same options and report the same errors.
- Added three `test-tree` layers to
`server/scripts/typecheck-layers.mjs`. They read the server layers as
declarations, and any error fails them. A hash of the path selects the
shard, so a new file does not move other files.
- Added `server/scripts/typecheck-stubs/daytona-sdk.d.ts`. Server tests
reach Daytona plugin source, and the root install does not have
`@daytonaio/sdk`.
- Changed two imports in `ui/src/lib/issue-execution-policy.ts` to use
`.js` extensions, because server tests import this file.
- Made `declarationsConfig` and `--declarations-only` skip the
`test-tree` layers, because these layers emit nothing. Other projects
read only the source layers. Added a test for this.
- Updated `doc/DEVELOPING.md`.

## Verification

Run these commands:

```sh
pnpm --filter @paperclipai/server typecheck
pnpm exec vitest run server/scripts/typecheck-layers.test.mjs
```

Results on macOS (arm64), Node 24, 16 cores. Each check ran after the
merge of paperclipai/paperclip#18738 unless the row says otherwise:

| Check | Commit | Result |
| --- | --- | --- |
| Server typecheck, `PAPERCLIP_TYPECHECK_LOW_MEMORY=1`, all 7 layers |
`6e45a08573` | Exit 0, 0 errors, 62 seconds, peak 3.52 GiB |
| `node scripts/typecheck-test-projects.mjs --low-memory` | `a3306bd13e`
| Exit 0, 0 errors, 42 seconds, peak 3.25 GiB |
| The same script with `--reuse-declarations` | `1b878aabc0` | Exit 0, 0
errors |
| `typecheck-layers.test.mjs` and `live-recovery-work.test.ts` |
`01db5634e4` | 90 passed. These include real compiler runs for a pass, a
type error, and an invalid tsconfig. |
| `tsconfig.declarations.json` after a full server typecheck |
`0fb1e4fb0a` | It references only `below`, `cycle`, and `above`. No
generated config names a `tsconfig.layers.json` file. |
| Owned runtime test in `idle-completed-history` | `e8f2f448ac` |
Passed, with the fix that master later replaced |
| `idle-incoming-wake`, `plugin-idle-manager`, and the changed
`chat-channels` test | `6e45a08573` | 30 passed |
| Runner `native-execution.test.ts` | `eab4dcc1f4` | 114 passed |
| The 19 server test files that changed since `eab4dcc1f4`, and
`typecheck-layers.test.mjs` | `259737b700` | 4,275 of 4,277 passed. The
2 failures are in `chat-channels` and are in the list of 7 below. |

The peak is the largest single process, from `/usr/bin/time -l`. Peaks
for the server typecheck were between 3.42 GiB and 3.56 GiB across 8
runs. Peaks for the test projects were 3.25 GiB and 3.37 GiB across 2
runs. I did not measure a cgroup.

**Runtime check of the fixes.** Types do not prove that a test still
works. So I ran all 309 changed server test files, 11,929 tests, before
the rebase onto paperclipai/paperclip#18737:

| Result | Tests | Detail |
| --- | --- | --- |
| Passed | 11,913 | Includes the 2 tests and the 54 `dot-runner` tests
that passed in a later run, as described below. |
| Failed | 7 | The same 7 tests also fail on the commit before the
fixes. |
| Skipped | 9 | These tests have their own skip conditions: `sentry` 5,
and 1 each in `bundled-plugin-registration`, `customer-success-cloud`,
`onepassword-connection`, and `workspace-runtime-https-live-exercise`. |

The 7 tests that fail with and without this change, on my machine:

- 3 tests in `chat-channels` and `email-channels` stop with `ENOENT` on
a `SKILL.md` file. The path is in the parent checkout, above the git
worktree that I used, so I expect that the worktree is the cause. I did
not prove this.
- `workspace-instance-cleanup` compares `/private/var/...` with
`/var/...`. This is a macOS symlink difference.
- 2 tests in `git-reproducible-managed-checkouts` get
`unknown_base_git_files` and expect `unpushed_managed_checkout`. I did
not find the cause.
- 1 more test in `chat-channels`, `materializes direct external-chat
finals once`, gets `undefined`. I did not find the cause.

CI is the check for these 7 tests. `ci / verify` passed on `eab4dcc1f4`.

Failures during this work:

- My fix to `agent-runtime-connector-access` changed an invalid
permission key in the setup, but not in the assertion. The runtime check
found this. I corrected the assertion, and the file passes.
- `heartbeat-plugin-environment` failed one wait in the full run. It
passed three times alone, so I think that load caused the failure. It
can fail again under load.
- `dot-runner` skipped all 54 tests in the full run because `cargo` was
not on my `PATH`. It then passed 54 of 54 with the toolchain on the
`PATH`.
- My first `lib` value removed the default DOM types, and the error
count went up by 375. I added the DOM libraries.
- My Daytona stub with bare `any` left 48 errors, because generic
helpers then inferred `unknown`. I added shapes that return promises.
- One fix to `agent-secrets-routes` used `class_3_static_lease`, and the
test failed. That class allows only specific paths. I reverted to
`unclassified`.
- `ci / General tests (server (8/12))` failed on `259737b700` because of
the flaky port in `idle-completed-history`. paperclipai/paperclip#18853
fixed this test on master, so this pull request keeps that fix.

**Audit of the diff.** I counted these patterns in added and removed
lines, to find fixes that only hide an error:

| Pattern | Added | Removed |
| --- | --- | --- |
| `@ts-ignore` | 0 | 0 |
| `@ts-expect-error` | 0 | 1 |
| `.skip` | 0 | 0 |
| `as any` | 9 | 9 |
| `: any` | 11 | 2 |
| `as never` | 8 | 2 |
| `as unknown as` | 35 | 4 |
| `Promise<unknown>` | 16 | 5 |
| `expect(` | 128 | 113 |

No hunk removes more `expect(` calls than it adds. Three removals of
test content were intentional, and I checked each one:

- `muse-control` removed `signalToken`. Line 1012 already asserts that
it is absent.
- `merged-pr-confirmation-sweep` removed legacy aliases. Other tests
cover them.
- `heartbeat-workspace-branch-containment` removed a `finalize` branch
that no test row can reach.

Some partial fixtures stay unchecked through `as unknown as` and
`Promise<unknown>`, mostly in `issue-agent-mutation-ownership-routes`
and `issue-comment-reopen-routes`.

**Accuracy of the check.** One program over the tree and the three
shards reported the same errors at the same positions. Memory, as the
peak of the largest process on one thread, was 3.93 GiB for one program
and 2.43 GiB for the largest shard. I measured these two values before
the fixes.

Not run or not proven:

- I did not run the full `pnpm test:run`, or a root `pnpm build`. I
expect CI to run the full suites.
- I did not run the 4 GiB container check, or the full
`scripts/typecheck-low-memory.mjs`. The peaks above come from macOS, so
they are not a Linux cgroup measurement.
- I did not run the UI typecheck after the merges.
- `workspace-runtime-https-live-exercise` is skipped, so its `cleanup`
fix did not run.

## Risks

- **A large diff in test files.** 328 files change. A pull request that
edits the same tests can get merge conflicts. New tests on master can
also add type errors before this merges. Any such error fails this check
and needs a fix here.
- **A higher cost for changes to source types.** A change to a type can
add errors in test files that the author did not touch. The author must
then fix them. This is the purpose of the check, but it is new work.
- **Changed test behavior.** Some tests now run paths that they did not
run before, such as the 9 chat wizard fixtures and the 3 span tests.
They pass here, but they can be more sensitive to timing or to the
environment.
- **The Daytona stub can go stale.** The stub is written by hand. If the
plugin uses a new SDK member, the typecheck reports an error until
someone updates the stub.
- **The release path.** `release-verify.yml` and `scripts/release.sh`
run `pnpm -r typecheck`, so they now run this check.
- **The tsconfig change.** The test transform reads
`server/src/__tests__/tsconfig.json`. The options that I changed are for
type checks, and the runs above passed.
- **A gap that remains.** Tsconfigs in `packages/paperclip-runner` and
in most sandbox provider plugins exclude `*.test.ts`. This check does
not read most of those test files, so they can still drift. That work is
separate from this pull request.

> 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

Anthropic Claude Opus 5.5 (`claude-opus-5-5`) through Claude Code, with
reasoning, tool use, code execution, and subagents. The runtime does not
show the context window size.

## 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
- [ ] I have run tests locally and they pass (7 tests fail locally, with
and without this change. See Verification.)
- [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-03 15:27:38 -08:00

820 lines
35 KiB
TypeScript

import { randomUUID } from "node:crypto";
import express from "express";
import request from "supertest";
import { mcpGatewayProtocolRoutes } from "../routes/tool-gateway.js";
import { eq, sql } from "drizzle-orm";
import { afterAll, afterEach, beforeAll, describe, expect, it } from "vitest";
import {
agents,
activityLog,
companies,
companyMemberships,
connectionGrants,
createDb,
heartbeatRuns,
toolAccessAuditEvents,
toolApplications,
toolConnectionInstalls,
toolConnections,
toolCatalogEntries,
toolMcpGateways,
toolMcpGatewayTokens,
toolProfileBindings,
toolProfileEntries,
toolProfiles,
} from "@paperclipai/db";
import {
getEmbeddedPostgresTestSupport,
startEmbeddedPostgresTestDatabase,
} from "./helpers/embedded-postgres.js";
import { buildPaperclipRuntimeMcpServers, createManagedMcpRunConfig } from "../services/heartbeat.js";
import { createToolGatewayService, ToolGatewayHttpError } from "../services/tool-gateway.js";
import { toolAccessService } from "../services/tool-access.js";
const embeddedPostgresSupport = await getEmbeddedPostgresTestSupport();
const describeEmbeddedPostgres = embeddedPostgresSupport.supported ? describe : describe.skip;
describeEmbeddedPostgres("heartbeat runtime MCP servers", () => {
let db!: ReturnType<typeof createDb>;
let tempDb: Awaited<ReturnType<typeof startEmbeddedPostgresTestDatabase>> | null = null;
const originalApiUrl = process.env.PAPERCLIP_API_URL;
beforeAll(async () => {
tempDb = await startEmbeddedPostgresTestDatabase("paperclip-heartbeat-runtime-mcp-");
db = createDb(tempDb.connectionString);
}, 20_000);
afterEach(async () => {
if (originalApiUrl === undefined) delete process.env.PAPERCLIP_API_URL;
else process.env.PAPERCLIP_API_URL = originalApiUrl;
await db.delete(toolMcpGatewayTokens);
await db.delete(activityLog);
await db.delete(toolAccessAuditEvents);
await db.delete(heartbeatRuns);
await db.delete(toolMcpGateways);
await db.delete(connectionGrants);
await db.delete(toolConnectionInstalls);
await db.delete(toolProfileBindings);
await db.delete(toolProfileEntries);
await db.delete(toolProfiles);
await db.delete(toolConnections);
await db.delete(toolApplications);
await db.delete(agents);
await db.delete(companyMemberships);
await db.delete(companies);
});
afterAll(async () => {
await tempDb?.cleanup();
});
it("provisions one aggregate gateway and omits unavailable access without blocking any runtime", async () => {
process.env.PAPERCLIP_API_URL = "https://paperclip.example.test";
const [company] = await db.insert(companies).values({
name: `Runtime MCP ${randomUUID()}`,
issuePrefix: `RM${randomUUID().slice(0, 5).toUpperCase()}`,
}).returning();
const [agent] = await db.insert(agents).values({
companyId: company!.id,
name: "Runtime MCP Agent",
role: "engineer",
adapterType: "codex_local",
adapterConfig: {},
}).returning();
const [application] = await db.insert(toolApplications).values({
companyId: company!.id,
applicationKey: `runtime-${randomUUID().slice(0, 8)}`,
name: "Runtime MCP App",
type: "mcp_http",
status: "active",
}).returning();
const [installedConnection, uninstalledConnection] = await db.insert(toolConnections).values([
{
companyId: company!.id,
applicationId: application!.id,
name: "Installed MCP",
uid: `test/${randomUUID()}`,
transport: "mcp_remote",
status: "active",
enabled: true,
config: { url: "https://installed.example.test/mcp" },
},
{
companyId: company!.id,
applicationId: application!.id,
name: "Uninstalled MCP",
uid: `test/${randomUUID()}`,
transport: "mcp_remote",
status: "active",
enabled: true,
config: { url: "https://uninstalled.example.test/mcp" },
},
]).returning();
const [profile] = await db.insert(toolProfiles).values({
companyId: company!.id,
profileKey: `app:${installedConnection!.id}`,
name: "Installed MCP",
defaultAction: "deny",
}).returning();
await db.insert(toolProfileEntries).values({
companyId: company!.id,
profileId: profile!.id,
selectorType: "connection",
effect: "include",
applicationId: application!.id,
connectionId: installedConnection!.id,
});
await db.insert(toolProfileBindings).values({
companyId: company!.id,
profileId: profile!.id,
targetType: "agent",
targetId: agent!.id,
});
await db.insert(toolConnectionInstalls).values({
companyId: company!.id,
connectionId: installedConnection!.id,
targetType: "agent",
targetId: agent!.id,
});
const before = Date.now();
const first = await buildPaperclipRuntimeMcpServers({ db, agent: agent!, runId: randomUUID() });
const second = await buildPaperclipRuntimeMcpServers({ db, agent: agent!, runId: randomUUID() });
expect(first).toHaveLength(1);
expect(first[0]).toMatchObject({
name: "paperclip-assigned",
connectionId: expect.stringMatching(/^assignment:[a-f0-9]{64}$/),
url: expect.stringMatching(/^https:\/\/paperclip\.example\.test\/mcp\/gateways\/gw_[a-f0-9]{32}$/),
token: expect.stringMatching(/^pcgw_/),
});
expect(JSON.stringify(first)).not.toContain(uninstalledConnection!.id);
expect(second).toHaveLength(1);
expect(second[0]!.connectionId).toBe(first[0]!.connectionId);
const gateways = await db.select().from(toolMcpGateways);
expect(gateways).toHaveLength(1);
// The column, not metadata, is what named-gateway auth checks run tokens against.
expect(gateways[0]!.agentId).toBe(agent!.id);
expect(gateways[0]!.metadata).toMatchObject({
nativeRuntimeAssignmentDigest: first[0]!.connectionId.slice("assignment:".length),
agentId: agent!.id,
});
const tokens = await db.select().from(toolMcpGatewayTokens);
expect(tokens).toHaveLength(2);
for (const token of tokens) {
expect(token.subjectType).toBe("heartbeat_run");
expect(token.subjectId).toMatch(/^[0-9a-f-]{36}$/);
expect(token.expiresAt!.getTime()).toBeGreaterThanOrEqual(before + 59 * 60 * 1000);
expect(token.expiresAt!.getTime()).toBeLessThanOrEqual(Date.now() + 61 * 60 * 1000);
}
expect(JSON.stringify(tokens)).not.toContain(first[0]!.token);
await expect(
buildPaperclipRuntimeMcpServers({
db,
agent: agent!,
runId: randomUUID(),
expectedAssignmentDigest: "0".repeat(64),
}),
).resolves.toEqual([]);
expect(await db.select().from(toolMcpGatewayTokens)).toHaveLength(2);
await db.update(toolConnections)
.set({ healthStatus: "degraded", healthMessage: "fixture unavailable" })
.where(eq(toolConnections.id, installedConnection!.id));
await expect(
buildPaperclipRuntimeMcpServers({
db,
agent: agent!,
runId: randomUUID(),
expectedAssignmentDigest: first[0]!.connectionId.slice("assignment:".length),
}),
).resolves.toEqual([]);
expect(await db.select().from(toolMcpGatewayTokens)).toHaveLength(2);
await expect(
createManagedMcpRunConfig({
db,
agent: agent!,
runId: randomUUID(),
config: {},
projectId: null,
issueId: null,
}),
).resolves.toBeNull();
});
async function seedAssignedAgents(count: number) {
process.env.PAPERCLIP_API_URL = "https://paperclip.example.test";
const [company] = await db.insert(companies).values({
name: `Runtime MCP ${randomUUID()}`,
issuePrefix: `RM${randomUUID().slice(0, 5).toUpperCase()}`,
}).returning();
const [application] = await db.insert(toolApplications).values({
companyId: company!.id,
applicationKey: `runtime-${randomUUID().slice(0, 8)}`,
name: "Runtime MCP App",
type: "mcp_http",
status: "active",
}).returning();
const [connection] = await db.insert(toolConnections).values({
companyId: company!.id,
applicationId: application!.id,
name: "Installed MCP",
uid: `test/${randomUUID()}`,
transport: "mcp_remote",
status: "active",
enabled: true,
config: { url: "https://installed.example.test/mcp" },
}).returning();
const [profile] = await db.insert(toolProfiles).values({
companyId: company!.id,
profileKey: `app:${connection!.id}`,
name: "Installed MCP",
defaultAction: "deny",
}).returning();
await db.insert(toolProfileEntries).values({
companyId: company!.id,
profileId: profile!.id,
selectorType: "connection",
effect: "include",
applicationId: application!.id,
connectionId: connection!.id,
});
const seeded = [];
for (let index = 0; index < count; index += 1) {
const [agent] = await db.insert(agents).values({
companyId: company!.id,
name: `Runtime MCP Agent ${index}`,
role: "engineer",
adapterType: "codex_local",
adapterConfig: {},
}).returning();
await db.insert(toolProfileBindings).values({
companyId: company!.id,
profileId: profile!.id,
targetType: "agent",
targetId: agent!.id,
});
await db.insert(toolConnectionInstalls).values({
companyId: company!.id,
connectionId: connection!.id,
targetType: "agent",
targetId: agent!.id,
});
const [run] = await db.insert(heartbeatRuns).values({
companyId: company!.id,
agentId: agent!.id,
status: "running",
contextSnapshot: {},
}).returning();
seeded.push({ agent: agent!, run: run! });
}
return seeded;
}
it("rejects another agent's run token on a run-scoped gateway", async () => {
const [owner, other] = await seedAssignedAgents(2);
const [server] = await buildPaperclipRuntimeMcpServers({ db, agent: owner!.agent, runId: owner!.run.id });
const [gateway] = await db.select().from(toolMcpGateways);
const service = createToolGatewayService(db);
const otherToken = await service.createNamedGatewayToken({
companyId: owner!.agent.companyId,
gatewayId: gateway!.id,
body: {
name: "Other agent run",
subjectType: "heartbeat_run",
subjectId: other!.run.id,
clientLabel: "Runtime MCP test client",
ownerNote: "",
allowedActions: ["tools/list", "tools/call"],
expiresAt: new Date(Date.now() + 60_000),
},
actor: { agentId: other!.agent.id },
});
await expect(
service.initializeNamedGatewayProtocol({ gatewayId: gateway!.id, bearerToken: server!.token }),
).resolves.toMatchObject({ agentId: owner!.agent.id, runId: owner!.run.id });
const rejection = await service
.initializeNamedGatewayProtocol({ gatewayId: gateway!.id, bearerToken: otherToken.token })
.catch((error: unknown) => error);
expect(rejection).toBeInstanceOf(ToolGatewayHttpError);
expect((rejection as ToolGatewayHttpError).reasonCode).toBe("gateway_token_run_context_invalid");
});
it("binds a reused run-scoped gateway that was created without an agent", async () => {
const [owner] = await seedAssignedAgents(1);
await buildPaperclipRuntimeMcpServers({ db, agent: owner!.agent, runId: owner!.run.id });
// Simulate a gateway provisioned before the agentId column was set.
await db.update(toolMcpGateways).set({ agentId: null });
await buildPaperclipRuntimeMcpServers({ db, agent: owner!.agent, runId: owner!.run.id });
const gateways = await db.select().from(toolMcpGateways);
expect(gateways).toHaveLength(1);
expect(gateways[0]!.agentId).toBe(owner!.agent.id);
});
it("rejects another run on a legacy native gateway before the owner runs again", async () => {
const [owner, other] = await seedAssignedAgents(2);
const [server] = await buildPaperclipRuntimeMcpServers({ db, agent: owner!.agent, runId: owner!.run.id });
const [gateway] = await db.select().from(toolMcpGateways);
await db.update(toolMcpGateways).set({ agentId: null }).where(eq(toolMcpGateways.id, gateway!.id));
const service = createToolGatewayService(db);
const token = await service.createNamedGatewayToken({
companyId: owner!.agent.companyId, gatewayId: gateway!.id,
body: { name: "Other run", subjectType: "heartbeat_run", subjectId: other!.run.id, clientLabel: "Runtime MCP test client", ownerNote: "",
allowedActions: ["tools/list"], expiresAt: new Date(Date.now() + 60_000) },
actor: { agentId: other!.agent.id },
});
await expect(service.initializeNamedGatewayProtocol({ gatewayId: gateway!.id, bearerToken: server!.token }))
.resolves.toMatchObject({ agentId: owner!.agent.id });
await expect(service.initializeNamedGatewayProtocol({ gatewayId: gateway!.id, bearerToken: token.token }))
.rejects.toMatchObject({ reasonCode: "gateway_token_run_context_invalid" });
const app = express().use(express.json()).use(mcpGatewayProtocolRoutes(service));
const initialize = (bearer: string) => request(app).post(`/mcp/gateways/${gateway!.gatewayPublicId}`)
.set("Authorization", `Bearer ${bearer}`).send({ jsonrpc: "2.0", id: 1, method: "initialize" });
await initialize(server!.token).expect(200);
await initialize(token.token).expect(401);
await db.update(toolMcpGateways).set({ metadata: { nativeRuntimeAssignmentDigest: "invalid" } })
.where(eq(toolMcpGateways.id, gateway!.id));
await expect(service.initializeNamedGatewayProtocol({ gatewayId: gateway!.id, bearerToken: server!.token }))
.rejects.toMatchObject({ reasonCode: "gateway_token_run_context_invalid" });
await db.update(toolMcpGateways).set({ metadata: gateway!.metadata }).where(eq(toolMcpGateways.id, gateway!.id));
await db.update(toolProfiles).set({ metadata: {} }).where(eq(toolProfiles.id, gateway!.profileId));
await expect(service.initializeNamedGatewayProtocol({ gatewayId: gateway!.id, bearerToken: server!.token }))
.rejects.toMatchObject({ reasonCode: "gateway_token_run_context_invalid" });
});
it("rejects a legacy native gateway with cleared metadata and omits it from managed discovery", async () => {
const [owner, other] = await seedAssignedAgents(2);
const [server] = await buildPaperclipRuntimeMcpServers({ db, agent: owner!.agent, runId: owner!.run.id });
const [gateway] = await db.select().from(toolMcpGateways);
await db.update(toolMcpGateways).set({ agentId: null, contextScopeType: "none", contextScopeId: null, metadata: {} })
.where(eq(toolMcpGateways.id, gateway!.id));
const service = createToolGatewayService(db);
const token = await service.createNamedGatewayToken({
companyId: owner!.agent.companyId, gatewayId: gateway!.id,
body: { name: "Other run", subjectType: "heartbeat_run", subjectId: other!.run.id, clientLabel: "Runtime MCP test client", ownerNote: "",
allowedActions: ["tools/list"], expiresAt: new Date(Date.now() + 60_000) },
actor: { agentId: other!.agent.id },
});
for (const bearerToken of [token.token, server!.token]) {
await expect(service.initializeNamedGatewayProtocol({ gatewayId: gateway!.id, bearerToken }))
.rejects.toMatchObject({ reasonCode: "gateway_token_run_context_invalid" });
}
for (const { agent, run } of [owner!, other!]) {
await expect(createManagedMcpRunConfig({ db, agent, runId: run.id, config: {}, projectId: null, issueId: null }))
.resolves.toBeNull();
}
// The immutable profile key still identifies the assignment if its metadata
// is also damaged. Neither authentication nor managed delivery can widen it.
await db.update(toolProfiles).set({ metadata: {} }).where(eq(toolProfiles.id, gateway!.profileId));
await expect(service.initializeNamedGatewayProtocol({ gatewayId: gateway!.id, bearerToken: token.token }))
.rejects.toMatchObject({ reasonCode: "gateway_token_run_context_invalid" });
await expect(createManagedMcpRunConfig({ db, agent: other!.agent, runId: other!.run.id,
config: {}, projectId: null, issueId: null })).resolves.toBeNull();
});
it("rejects JSON null profile metadata with an HTTP authentication response", async () => {
const [owner] = await seedAssignedAgents(1);
const [server] = await buildPaperclipRuntimeMcpServers({ db, agent: owner!.agent, runId: owner!.run.id });
const [gateway] = await db.select().from(toolMcpGateways);
await db.update(toolProfiles).set({ metadata: sql`'null'::jsonb` }).where(eq(toolProfiles.id, gateway!.profileId));
const service = createToolGatewayService(db);
await expect(service.initializeNamedGatewayProtocol({ gatewayId: gateway!.id, bearerToken: server!.token }))
.rejects.toMatchObject({ reasonCode: "gateway_token_run_context_invalid" });
const app = express().use(express.json()).use(mcpGatewayProtocolRoutes(service));
await request(app).post(`/mcp/gateways/${gateway!.gatewayPublicId}`)
.set("Authorization", `Bearer ${server!.token}`).send({ jsonrpc: "2.0", id: 1, method: "initialize" }).expect(401);
});
it("delivers native assignments once and preserves explicit shared gateways", async () => {
const [owner, other] = await seedAssignedAgents(2);
const native = await buildPaperclipRuntimeMcpServers({ db, agent: owner!.agent, runId: owner!.run.id });
expect(native).toHaveLength(1);
const [gateway] = await db.select().from(toolMcpGateways);
// All assignment history, including gateways written before owner columns
// existed, belongs to the native delivery path rather than managed config.
await db.update(toolMcpGateways).set({ agentId: null, contextScopeType: "none", contextScopeId: null });
for (const agent of [owner!.agent, other!.agent]) {
await expect(createManagedMcpRunConfig({ db, agent, runId: owner!.run.id, config: {}, projectId: null, issueId: null }))
.resolves.toBeNull();
}
const [sharedProfile] = await db.insert(toolProfiles).values({
companyId: owner!.agent.companyId, profileKey: `shared:${randomUUID()}`,
name: "Explicit shared profile", defaultAction: "deny",
}).returning();
const [nativeEntry] = await db.select().from(toolProfileEntries).where(eq(toolProfileEntries.profileId, gateway!.profileId));
await db.insert(toolProfileEntries).values({
companyId: owner!.agent.companyId, profileId: sharedProfile!.id, selectorType: "connection", effect: "include",
applicationId: nativeEntry!.applicationId, connectionId: nativeEntry!.connectionId,
});
const service = createToolGatewayService(db);
const shared = await service.createNamedGateway({
companyId: owner!.agent.companyId,
body: { name: "Explicit company gateway", slug: `shared-${randomUUID()}`, profileId: sharedProfile!.id,
defaultProfileMode: "gateway_only" },
actor: { agentId: owner!.agent.id },
});
const managed = await createManagedMcpRunConfig({ db, agent: other!.agent, runId: other!.run.id,
config: {}, projectId: null, issueId: null });
expect(managed?.gateways.map((entry) => entry.id)).toEqual([shared.id]);
const token = await service.createNamedGatewayToken({
companyId: owner!.agent.companyId, gatewayId: shared.id,
body: { name: "Shared run", subjectType: "heartbeat_run", subjectId: other!.run.id, clientLabel: "Runtime MCP test client", ownerNote: "",
allowedActions: ["tools/list"], expiresAt: new Date(Date.now() + 60_000) },
actor: { agentId: other!.agent.id },
});
await expect(service.initializeNamedGatewayProtocol({ gatewayId: shared.id, bearerToken: token.token }))
.resolves.toMatchObject({ agentId: other!.agent.id });
});
it("does not repair a gateway with conflicting ownership metadata", async () => {
const [owner, other] = await seedAssignedAgents(2);
const [server] = await buildPaperclipRuntimeMcpServers({ db, agent: owner!.agent, runId: owner!.run.id });
await db.update(toolMcpGateways).set({ agentId: null,
metadata: { nativeRuntimeAssignmentDigest: server!.connectionId.slice("assignment:".length), agentId: other!.agent.id } });
await expect(buildPaperclipRuntimeMcpServers({ db, agent: owner!.agent, runId: owner!.run.id }))
.rejects.toThrow("Invalid native runtime gateway provenance");
const [gateway] = await db.select().from(toolMcpGateways);
expect(gateway!.agentId).toBeNull();
});
it("preserves exact permissions when an aggregate assignment exceeds the public 250-entry edit limit", async () => {
process.env.PAPERCLIP_API_URL = "https://paperclip.example.test";
const [company] = await db.insert(companies).values({
name: "Large MCP assignment",
issuePrefix: `LM${randomUUID().slice(0, 5).toUpperCase()}`,
}).returning();
const [agent, gatewayReader] = await db.insert(agents).values([
{ companyId: company!.id, name: "Cursor Cloud", role: "engineer", adapterType: "cursor_cloud" },
{ companyId: company!.id, name: "Gateway reader", role: "engineer", adapterType: "cursor_cloud" },
]).returning();
const [application] = await db.insert(toolApplications).values({
companyId: company!.id, applicationKey: "large-mcp", name: "Large MCP", type: "mcp_http",
}).returning();
const [connection] = await db.insert(toolConnections).values({
companyId: company!.id, applicationId: application!.id,
name: "Large MCP", uid: `test/${randomUUID()}`, transport: "mcp_remote", status: "active", enabled: true,
config: { url: "https://large.example.test/mcp" },
}).returning();
const catalogInput = (name: string) => ({
companyId: company!.id, applicationId: application!.id, connectionId: connection!.id,
name, toolName: name, versionHash: "fixture", status: "active" as const,
});
const catalog = await db.insert(toolCatalogEntries).values([
...Array.from({ length: 251 }, (_, index) => catalogInput(`allowed_${index}`)),
catalogInput("excluded"), catalogInput("unassigned"),
]).returning();
const allowed = catalog.slice(0, 251);
const excluded = catalog[251]!;
// Multiple valid profiles can each have fewer than 250 entries while their
// union exceeds the HTTP edit-request limit.
const profiles = await db.insert(toolProfiles).values(["first", "second"].map((key) => ({
companyId: company!.id, profileKey: key, name: key, defaultAction: "deny" as const,
}))).returning();
await db.insert(toolProfileEntries).values([
...[...allowed, excluded].map((tool, index) => ({
companyId: company!.id, profileId: profiles[index < 200 ? 0 : 1]!.id,
selectorType: "catalog_entry" as const, effect: "include" as const,
applicationId: application!.id, connectionId: connection!.id, catalogEntryId: tool.id,
})),
{
companyId: company!.id, profileId: profiles[1]!.id,
selectorType: "catalog_entry" as const, effect: "exclude" as const,
applicationId: application!.id, connectionId: connection!.id, catalogEntryId: excluded.id,
},
]);
await db.insert(toolProfileBindings).values(profiles.map((profile) => ({
companyId: company!.id, profileId: profile.id, targetType: "agent" as const, targetId: agent!.id,
})));
await db.insert(toolConnectionInstalls).values({
companyId: company!.id, connectionId: connection!.id, targetType: "agent", targetId: agent!.id,
});
const servers = await buildPaperclipRuntimeMcpServers({ db, agent: agent!, runId: randomUUID() });
expect(servers).toHaveLength(1);
const [gateway] = await db.select().from(toolMcpGateways);
const generatedEntries = await db.select().from(toolProfileEntries)
.where(eq(toolProfileEntries.profileId, gateway!.profileId!));
expect(generatedEntries).toHaveLength(251);
expect(generatedEntries.every((entry) => entry.selectorType === "catalog_entry")).toBe(true);
expect(generatedEntries.map((entry) => entry.catalogEntryId).sort()).toEqual(allowed.map((tool) => tool.id).sort());
// Evaluate the generated profile independently of the original assignments,
// including a tool discovered after the immutable profile was created.
await db.insert(toolCatalogEntries).values(catalogInput("new_after_snapshot"));
await db.insert(toolProfileBindings).values({
companyId: company!.id, profileId: gateway!.profileId!, targetType: "agent", targetId: gatewayReader!.id,
});
const effective = await toolAccessService(db).getEffectiveProfilesForAgent(company!.id, gatewayReader!.id);
expect(effective.allowedTools.map((tool) => tool.id).sort()).toEqual(allowed.map((tool) => tool.id).sort());
expect(effective.allowedToolNames).not.toContain("excluded");
expect(effective.allowedToolNames).not.toContain("unassigned");
expect(effective.allowedToolNames).not.toContain("new_after_snapshot");
const reused = await buildPaperclipRuntimeMcpServers({ db, agent: agent!, runId: randomUUID() });
expect(reused[0]!.connectionId).toBe(servers[0]!.connectionId);
expect(await db.select().from(toolMcpGateways)).toHaveLength(1);
});
it("exposes only the dedicated GitHub connection when a personal connection is also installed", async () => {
process.env.PAPERCLIP_API_URL = "https://paperclip.example.test";
const [company] = await db.insert(companies).values({
name: `Runtime GitHub identity ${randomUUID()}`,
issuePrefix: `RG${randomUUID().slice(0, 5).toUpperCase()}`,
}).returning();
await db.insert(companyMemberships).values({
companyId: company!.id,
principalType: "user",
principalId: "responsible-user",
status: "active",
membershipRole: "member",
});
const [agent] = await db.insert(agents).values({
companyId: company!.id,
name: "Dedicated GitHub Agent",
role: "engineer",
adapterType: "codex_local",
adapterConfig: {},
}).returning();
const [application] = await db.insert(toolApplications).values({
companyId: company!.id,
applicationKey: `github-${randomUUID().slice(0, 8)}`,
name: "GitHub",
type: "mcp_http",
status: "active",
metadata: { sourceTemplateKey: "github" },
}).returning();
const [personal, dedicated] = await db.insert(toolConnections).values([
{
companyId: company!.id,
applicationId: application!.id,
name: "Responsible user's GitHub",
uid: `github/${randomUUID()}`,
transport: "mcp_remote",
credentialPolicy: "per_user",
status: "active",
enabled: true,
healthStatus: "ok",
config: {},
transportConfig: { sourceTemplateKey: "github" },
},
{
companyId: company!.id,
applicationId: application!.id,
name: "Dedicated GitHub",
uid: `github/${randomUUID()}`,
transport: "mcp_remote",
credentialPolicy: "per_agent",
status: "active",
enabled: true,
healthStatus: "ok",
config: {},
transportConfig: { sourceTemplateKey: "github" },
},
]).returning();
await db.insert(connectionGrants).values([
{
companyId: company!.id,
connectionId: personal!.id,
kind: "user",
subjectUserId: "responsible-user",
status: "active",
isDefault: false,
},
{
companyId: company!.id,
connectionId: dedicated!.id,
kind: "agent",
subjectAgentId: agent!.id,
status: "active",
isDefault: false,
},
]);
await db.insert(toolConnectionInstalls).values([
{
companyId: company!.id,
connectionId: personal!.id,
targetType: "company",
targetId: company!.id,
},
{
companyId: company!.id,
connectionId: dedicated!.id,
targetType: "agent",
targetId: agent!.id,
},
]);
const [profile] = await db.insert(toolProfiles).values({
companyId: company!.id,
profileKey: `github-identities:${agent!.id}`,
name: "GitHub identities",
defaultAction: "deny",
}).returning();
await db.insert(toolProfileEntries).values([personal!, dedicated!].map((connection) => ({
companyId: company!.id,
profileId: profile!.id,
selectorType: "connection" as const,
effect: "include" as const,
applicationId: application!.id,
connectionId: connection.id,
})));
await db.insert(toolProfileBindings).values({
companyId: company!.id,
profileId: profile!.id,
targetType: "agent",
targetId: agent!.id,
});
const [run] = await db.insert(heartbeatRuns).values({
companyId: company!.id,
agentId: agent!.id,
status: "running",
responsibleUserId: "responsible-user",
contextSnapshot: {},
}).returning();
const servers = await buildPaperclipRuntimeMcpServers({ db, agent: agent!, runId: run!.id });
expect(servers).toHaveLength(1);
const [runtimeGateway] = await db.select().from(toolMcpGateways);
expect(runtimeGateway).toBeTruthy();
const runtimeEntries = await db.select().from(toolProfileEntries)
.where(eq(toolProfileEntries.profileId, runtimeGateway!.profileId!));
expect(runtimeEntries.map((entry) => entry.connectionId)).toEqual([dedicated!.id]);
});
it("audits permitted remote MCP connections that were not installed when delivery is empty", async () => {
const [company] = await db.insert(companies).values({
name: `Runtime MCP diagnostic ${randomUUID()}`,
issuePrefix: `RD${randomUUID().slice(0, 5).toUpperCase()}`,
}).returning();
const [agent] = await db.insert(agents).values({
companyId: company!.id,
name: "Runtime MCP Diagnostic Agent",
role: "engineer",
adapterType: "codex_local",
adapterConfig: {},
}).returning();
const [application] = await db.insert(toolApplications).values({
companyId: company!.id,
applicationKey: `runtime-diagnostic-${randomUUID().slice(0, 8)}`,
name: "Zapier",
type: "mcp_http",
status: "active",
}).returning();
const [connection] = await db.insert(toolConnections).values({
companyId: company!.id,
applicationId: application!.id,
name: "Zapier",
uid: `test/${randomUUID()}`,
transport: "mcp_remote",
status: "active",
enabled: true,
config: { url: "https://zapier.example.test/mcp" },
}).returning();
const [profile] = await db.insert(toolProfiles).values({
companyId: company!.id,
profileKey: `app:${connection!.id}`,
name: "Zapier",
defaultAction: "deny",
}).returning();
await db.insert(toolProfileEntries).values({
companyId: company!.id,
profileId: profile!.id,
selectorType: "connection",
effect: "include",
applicationId: application!.id,
connectionId: connection!.id,
});
await db.insert(toolProfileBindings).values({
companyId: company!.id,
profileId: profile!.id,
targetType: "agent",
targetId: agent!.id,
});
const runId = randomUUID();
await db.insert(heartbeatRuns).values({
id: runId,
companyId: company!.id,
agentId: agent!.id,
status: "running",
contextSnapshot: {},
});
const servers = await buildPaperclipRuntimeMcpServers({ db, agent: agent!, runId });
expect(servers).toEqual([]);
const [activity] = await db
.select()
.from(activityLog)
.where(eq(activityLog.action, "tool_gateway.runtime_mcp_delivery"));
expect(activity).toMatchObject({
companyId: company!.id,
agentId: agent!.id,
runId,
details: expect.objectContaining({
reasonCode: "permitted_connections_not_installed",
deliveredServerCount: 0,
permittedNotInstalledCount: 1,
permittedNotInstalledConnections: [{ id: connection!.id, name: "Zapier" }],
}),
});
const [audit] = await db.select().from(toolAccessAuditEvents);
expect(audit).toMatchObject({
companyId: company!.id,
actorType: "agent",
actorId: agent!.id,
reasonCode: "permitted_connections_not_installed",
details: expect.objectContaining({ runId, deliveredServerCount: 0 }),
});
});
it("injects only managed gateways whose profile connections are installed for the agent", async () => {
const [company] = await db.insert(companies).values({
name: `Managed gateway installs ${randomUUID()}`,
issuePrefix: `MG${randomUUID().slice(0, 5).toUpperCase()}`,
}).returning();
const [agent] = await db.insert(agents).values({
companyId: company!.id,
name: "Managed Gateway Agent",
role: "engineer",
adapterType: "codex_local",
adapterConfig: {},
}).returning();
const [application] = await db.insert(toolApplications).values({
companyId: company!.id,
applicationKey: `managed-gateway-${randomUUID().slice(0, 8)}`,
name: "Managed Gateway App",
type: "mcp_http",
status: "active",
}).returning();
const connections = await db.insert(toolConnections).values([
{
companyId: company!.id,
applicationId: application!.id,
name: "Installed gateway connection",
uid: `test/${randomUUID()}`,
transport: "mcp_remote",
status: "active",
enabled: true,
},
{
companyId: company!.id,
applicationId: application!.id,
name: "Uninstalled gateway connection",
uid: `test/${randomUUID()}`,
transport: "mcp_remote",
status: "active",
enabled: true,
},
]).returning();
const profiles = await db.insert(toolProfiles).values(connections.map((connection) => ({
companyId: company!.id,
profileKey: `gateway:${connection.id}`,
name: connection.name,
defaultAction: "deny" as const,
}))).returning();
await db.insert(toolProfileEntries).values(profiles.map((profile, index) => ({
companyId: company!.id,
profileId: profile.id,
selectorType: "connection" as const,
effect: "include" as const,
connectionId: connections[index]!.id,
})));
const gateways = await db.insert(toolMcpGateways).values(profiles.map((profile, index) => ({
companyId: company!.id,
name: `${connections[index]!.name} gateway`,
slug: `gateway-${index}-${randomUUID().slice(0, 8)}`,
profileId: profile.id,
status: "active" as const,
}))).returning();
await db.insert(toolConnectionInstalls).values({
companyId: company!.id,
connectionId: connections[0]!.id,
targetType: "agent",
targetId: agent!.id,
});
const config = await createManagedMcpRunConfig({
db,
agent: agent!,
runId: randomUUID(),
config: {},
projectId: null,
issueId: null,
});
expect(config?.gateways).toHaveLength(1);
expect(config?.gateways[0]).toMatchObject({
id: gateways[0]!.id,
name: gateways[0]!.name,
endpointPath: `/mcp/gateways/${gateways[0]!.gatewayPublicId}`,
});
expect(config?.gateways.some((gateway) => gateway.id === gateways[1]!.id)).toBe(false);
});
});