mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-01 06:42:06 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - Governed MCP access spans contracts, runtime enforcement, adapters, UI surfaces, and operator verification > - The parity reference PR #9534 is too large for effective automated or human review > - The feature therefore needs a linear stack whose individual diffs stay below the 100-file review limit > - This pull request is split 6/8 and focuses on UI API, shared components, and Tools/Profile surfaces > - The benefit is a standalone, testable review boundary while preserving byte-for-byte parity at the top of the stack ## Linked Issues or Issue Description - Related parity reference: #9534 - Problem: Operators need typed clients and administration surfaces that compile independently before navigation exposes them. - Proposed solution: Adds UI APIs, hooks, libraries, shared components, Tools/Profiles pages, and the plugin settings consumer required by the new company-scoped API. - Alternatives considered: keeping #9534 as one 403-file review, or rewriting the feature to manufacture seams; both were rejected in favor of path extraction plus compile-driven boundary moves. - Roadmap alignment: this advances the existing governed MCP/tool-access work already represented by #9534; it does not introduce a separate roadmap initiative. - Stack position: base branch is `pap10341-split/05-runtime-integration`. - Merge policy: merge bottom-up, in order, only after the complete eight-PR stack has been reviewed and the top-of-stack parity gate remains empty. - Requested review: UXDesigner sanity pass on Tools/Profile surfaces; Greptile on every PR. ## What Changed - Adds UI APIs, hooks, libraries, shared components, Tools/Profiles pages, and the plugin settings consumer required by the new company-scoped API. - Keeps this PR below 100 changed files and independently typecheckable. - Preserves the final tree from #9534 when combined with the other seven stack levels. ## Verification - `pnpm typecheck` - `pnpm check:token-gates` — all gates clean - Focused UI Vitest run with `NODE_ENV=test` — 28 files, 183 tests passed ## Risks - Large dead-code UI additions can drift from activation routes; PR 7 supplies the registration layer and top-level parity catches omissions. - Stack risk: merging out of order can expose incomplete layers; mitigate by following the documented bottom-up merge policy. - Parity risk: later edits to an intermediate branch can drift from #9534; mitigate by re-running the empty top-of-stack diff before merge. > 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 - OpenAI Codex, exact model ID `gpt-5.4`; runtime-managed context window; medium reasoning with repository, shell, Git, GitHub CLI, and code-execution tools enabled. ## 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] Internal references are omitted except the execution-plan link explicitly required for this coordinated split stack - [x] My branch name describes the change 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 ## Stack Coordination - Internal execution plan: [PAP-13874](/PAP/issues/PAP-13874#document-plan) - Parity reference: #9534 - Stack: #9556 → #9557 → #9558 → #9559 → #9560 → #9561 → #9562 → #9563 - Merge bottom-up only after full-stack review and an empty parity diff at #9563. ## UI Evidence QA captured these from the live Garden MCP split stack at 1440px and verified clean rendering:    --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
196 lines
5.6 KiB
TypeScript
196 lines
5.6 KiB
TypeScript
// @vitest-environment jsdom
|
|
|
|
import { describe, expect, it } from "vitest";
|
|
import type {
|
|
ToolCatalogEntry,
|
|
ToolProfileEntry,
|
|
ToolProfileWithDetails,
|
|
} from "@paperclipai/shared";
|
|
import { resolveAllowList } from "./ProfilesTab";
|
|
|
|
function tool(partial: Partial<ToolCatalogEntry> & { id: string; toolName: string }): ToolCatalogEntry {
|
|
return {
|
|
companyId: "c1",
|
|
applicationId: "app-slack",
|
|
connectionId: "conn-1",
|
|
entryKind: "tool",
|
|
title: null,
|
|
description: null,
|
|
inputSchema: null,
|
|
outputSchema: null,
|
|
annotations: null,
|
|
riskLevel: "read",
|
|
isReadOnly: true,
|
|
isWrite: false,
|
|
isDestructive: false,
|
|
status: "active",
|
|
version: null,
|
|
schemaHash: null,
|
|
firstSeenAt: new Date(),
|
|
lastSeenAt: new Date(),
|
|
reviewedAt: null,
|
|
reviewedByAgentId: null,
|
|
reviewedByUserId: null,
|
|
createdAt: new Date(),
|
|
updatedAt: new Date(),
|
|
...partial,
|
|
} as ToolCatalogEntry;
|
|
}
|
|
|
|
function entry(partial: Partial<ToolProfileEntry> & Pick<ToolProfileEntry, "selectorType">): ToolProfileEntry {
|
|
return {
|
|
id: `e-${Math.round(Math.random() * 1e9)}`,
|
|
companyId: "c1",
|
|
profileId: "p1",
|
|
effect: "include",
|
|
applicationId: null,
|
|
connectionId: null,
|
|
catalogEntryId: null,
|
|
toolName: null,
|
|
riskLevel: null,
|
|
conditions: null,
|
|
createdAt: new Date(),
|
|
updatedAt: new Date(),
|
|
...partial,
|
|
} as ToolProfileEntry;
|
|
}
|
|
|
|
function profile(partial: Partial<ToolProfileWithDetails>): ToolProfileWithDetails {
|
|
return {
|
|
id: "p1",
|
|
companyId: "c1",
|
|
profileKey: "k",
|
|
name: "Profile",
|
|
description: null,
|
|
status: "active",
|
|
defaultAction: "deny",
|
|
newToolsReviewedAt: null,
|
|
metadata: null,
|
|
createdAt: new Date(),
|
|
updatedAt: new Date(),
|
|
entries: [],
|
|
bindings: [],
|
|
summary: {
|
|
accessMode: "selected",
|
|
allowedToolCount: 0,
|
|
allowedApplicationCount: 0,
|
|
excludedToolCount: 0,
|
|
totalToolCount: 0,
|
|
assignmentCount: 0,
|
|
appliesToAgentCount: 0,
|
|
isCompanyDefault: false,
|
|
},
|
|
...partial,
|
|
};
|
|
}
|
|
|
|
const appsById = new Map([["app-slack", "Slack"]]);
|
|
const connsById = new Map([["conn-1", "Slack prod"]]);
|
|
|
|
const catalog: ToolCatalogEntry[] = [
|
|
tool({ id: "t-list-channels", toolName: "slack.list_channels", riskLevel: "read" }),
|
|
tool({ id: "t-list-users", toolName: "slack.list_users", riskLevel: "read" }),
|
|
tool({
|
|
id: "t-post",
|
|
toolName: "slack.post_message",
|
|
riskLevel: "medium",
|
|
isReadOnly: false,
|
|
isWrite: true,
|
|
}),
|
|
];
|
|
|
|
describe("resolveAllowList", () => {
|
|
it("marks an exact tool_name include as explicit", () => {
|
|
const rows = resolveAllowList(
|
|
profile({ entries: [entry({ selectorType: "tool_name", toolName: "slack.post_message" })] }),
|
|
catalog,
|
|
appsById,
|
|
connsById,
|
|
);
|
|
expect(rows).toHaveLength(1);
|
|
expect(rows[0].toolName).toBe("slack.post_message");
|
|
expect(rows[0].source).toEqual({ kind: "explicit" });
|
|
expect(rows[0].applicationName).toBe("Slack");
|
|
expect(rows[0].isWrite).toBe(true);
|
|
});
|
|
|
|
it("flags wildcard tool_name matches as a pattern source", () => {
|
|
const rows = resolveAllowList(
|
|
profile({ entries: [entry({ selectorType: "tool_name", toolName: "slack.list_*" })] }),
|
|
catalog,
|
|
appsById,
|
|
connsById,
|
|
);
|
|
const names = rows.map((r) => r.toolName).sort();
|
|
expect(names).toEqual(["slack.list_channels", "slack.list_users"]);
|
|
expect(rows.every((r) => r.source.kind === "pattern" && r.source.label === "slack.list_*")).toBe(true);
|
|
});
|
|
|
|
it("labels application selectors as pattern app:<name>", () => {
|
|
const rows = resolveAllowList(
|
|
profile({ entries: [entry({ selectorType: "application", applicationId: "app-slack" })] }),
|
|
catalog,
|
|
appsById,
|
|
connsById,
|
|
);
|
|
expect(rows).toHaveLength(3);
|
|
expect(rows[0].source).toEqual({ kind: "pattern", label: "app:Slack" });
|
|
});
|
|
|
|
it("prefers an explicit grant over an overlapping pattern", () => {
|
|
const rows = resolveAllowList(
|
|
profile({
|
|
entries: [
|
|
entry({ selectorType: "application", applicationId: "app-slack" }),
|
|
entry({ selectorType: "tool_name", toolName: "slack.post_message" }),
|
|
],
|
|
}),
|
|
catalog,
|
|
appsById,
|
|
connsById,
|
|
);
|
|
const post = rows.find((r) => r.toolName === "slack.post_message");
|
|
expect(post?.source).toEqual({ kind: "explicit" });
|
|
});
|
|
|
|
it("removes excluded tools even when a pattern would include them", () => {
|
|
const rows = resolveAllowList(
|
|
profile({
|
|
entries: [
|
|
entry({ selectorType: "application", applicationId: "app-slack" }),
|
|
entry({ selectorType: "tool_name", toolName: "slack.post_message", effect: "exclude" }),
|
|
],
|
|
}),
|
|
catalog,
|
|
appsById,
|
|
connsById,
|
|
);
|
|
expect(rows.find((r) => r.toolName === "slack.post_message")).toBeUndefined();
|
|
expect(rows).toHaveLength(2);
|
|
});
|
|
|
|
it("includes the whole catalog by default when defaultAction is allow", () => {
|
|
const rows = resolveAllowList(
|
|
profile({ defaultAction: "allow" }),
|
|
catalog,
|
|
appsById,
|
|
connsById,
|
|
);
|
|
expect(rows).toHaveLength(3);
|
|
expect(rows.every((r) => r.source.kind === "default")).toBe(true);
|
|
});
|
|
|
|
it("keeps an explicit grant visible even when the catalog has no match", () => {
|
|
const rows = resolveAllowList(
|
|
profile({ entries: [entry({ selectorType: "tool_name", toolName: "github.create_pr" })] }),
|
|
catalog,
|
|
appsById,
|
|
connsById,
|
|
);
|
|
expect(rows).toHaveLength(1);
|
|
expect(rows[0].toolName).toBe("github.create_pr");
|
|
expect(rows[0].source).toEqual({ kind: "explicit" });
|
|
expect(rows[0].risk).toBeNull();
|
|
});
|
|
});
|