mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-07 07:23:08 +02: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 2/8 and focuses on database schema and shared governance contracts > - 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: The governed access model needs additive persistence and synchronized shared types before server enforcement can compile. - Proposed solution: Adds migrations 0148–0169, tool-access and Smoke Lab schema, shared types/validators/gallery helpers, and the minimal compile-required contract consumers identified by boundary testing. - 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/01-demo-servers`. - 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: QA for migrations/validators; Greptile on every PR. ## What Changed - Adds migrations 0148–0169, tool-access and Smoke Lab schema, shared types/validators/gallery helpers, and the minimal compile-required contract consumers identified by boundary testing. - 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` — passed, including migration numbering and safety checks - `pnpm --filter @paperclipai/db test` — passed - `pnpm --filter @paperclipai/shared test` — passed ## Risks - Migration or contract mistakes could affect every upper layer; all migrations are additive/idempotent and compile consumers are included in this boundary. - 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. --------- Co-authored-by: Paperclip <noreply@paperclip.ing>
104 lines
3.8 KiB
TypeScript
104 lines
3.8 KiB
TypeScript
/**
|
|
* Humanize engineering connection / tool identifiers for the prosumer Apps
|
|
* surfaces (PAP-10897).
|
|
*
|
|
* `connection.name` (and tool ids) can carry raw IPs, `Plugin:` prefixes with
|
|
* dotted package paths, and `vendor:tool` ids. None of that vocabulary may leak
|
|
* into `/apps`, `/apps/attention`, or the App-detail header — only `/apps/advanced`
|
|
* is allowed to show the raw identifiers. This module turns those identifiers
|
|
* into recognizable, plain-language labels.
|
|
*/
|
|
|
|
export interface HumanizableConnection {
|
|
name: string;
|
|
}
|
|
|
|
type ConnectionLike = HumanizableConnection | string | null | undefined;
|
|
|
|
function rawNameOf(input: ConnectionLike): string {
|
|
return (typeof input === "string" ? input : (input?.name ?? "")).trim();
|
|
}
|
|
|
|
/** IP / URL / host:port / localhost — anything that reads as a network address. */
|
|
function looksLikeNetworkAddress(raw: string): boolean {
|
|
const v = raw.toLowerCase();
|
|
if (v.includes("://")) return true; // any URL
|
|
if (v === "localhost" || v.startsWith("localhost:")) return true;
|
|
if (/^\d{1,3}(\.\d{1,3}){3}(:\d+)?$/.test(v)) return true; // IPv4 (optional :port)
|
|
if (/^[a-z0-9.-]+:\d+$/.test(v)) return true; // host:port
|
|
return false;
|
|
}
|
|
|
|
/** Title-case a snake/kebab/dotted identifier: `update_note` → `Update Note`. */
|
|
function titleCaseIdentifier(value: string): string {
|
|
return value
|
|
.split(/[\s._-]+/)
|
|
.filter(Boolean)
|
|
.map((word) => word.charAt(0).toUpperCase() + word.slice(1).toLowerCase())
|
|
.join(" ");
|
|
}
|
|
|
|
/** `Plugin: paperclipai.plugin-briefs` → `Briefs`; null when not a plugin label. */
|
|
function pluginPackageLabel(raw: string): string | null {
|
|
const match = /^plugin:\s*(.+)$/i.exec(raw);
|
|
if (!match) return null;
|
|
let leaf = match[1].trim();
|
|
// Keep the package leaf only: `paperclipai.plugin-briefs` → `plugin-briefs`.
|
|
leaf = leaf.slice(leaf.lastIndexOf(".") + 1);
|
|
// Drop the `plugin-` scaffolding leftover: `plugin-briefs` → `briefs`.
|
|
leaf = leaf.replace(/^plugin[-_]/i, "");
|
|
return titleCaseIdentifier(leaf) || "Custom app";
|
|
}
|
|
|
|
/**
|
|
* Turn an app/connection identifier (or a tool id) into a prosumer-friendly
|
|
* label. Pass `options.title` (e.g. a catalog entry's `title`) to prefer a
|
|
* known human title over any derivation.
|
|
*
|
|
* `127.0.0.1` → `Custom app`
|
|
* `Plugin: paperclipai.plugin-briefs` → `Briefs`
|
|
* `mcp-remote-fixture:update_note` → `Update Note`
|
|
* `Zapier` / `Notion` → unchanged
|
|
*/
|
|
export function humanizeConnectionDisplayName(
|
|
input: ConnectionLike,
|
|
options: { title?: string | null } = {},
|
|
): string {
|
|
const title = options.title?.trim();
|
|
if (title) return title; // a real, human title always wins
|
|
|
|
const raw = rawNameOf(input);
|
|
if (!raw) return "Custom app";
|
|
|
|
if (looksLikeNetworkAddress(raw)) return "Custom app";
|
|
|
|
const pluginLabel = pluginPackageLabel(raw);
|
|
if (pluginLabel) return pluginLabel;
|
|
|
|
// `vendor:tool` id (e.g. `mcp-remote-fixture:update_note`) → tool segment.
|
|
if (raw.includes(":") && !raw.includes("://")) {
|
|
const tool = raw.slice(raw.lastIndexOf(":") + 1).trim();
|
|
if (tool) return titleCaseIdentifier(tool);
|
|
}
|
|
|
|
// Already human (a space or any capital) → pass through untouched.
|
|
if (/\s/.test(raw) || /[A-Z]/.test(raw)) return raw;
|
|
|
|
// Bare snake/kebab/dotted identifier → Title Case With Spaces.
|
|
if (/[._-]/.test(raw)) return titleCaseIdentifier(raw);
|
|
|
|
return raw;
|
|
}
|
|
|
|
/**
|
|
* Optional secondary line for the App-detail page only: when the raw name is a
|
|
* network address we hide it from the header but may still show `hosted at …`
|
|
* underneath as a small trust/clarity hint. Returns null when there's nothing
|
|
* worth surfacing.
|
|
*/
|
|
export function connectionDisplaySecondaryHint(input: ConnectionLike): string | null {
|
|
const raw = rawNameOf(input);
|
|
if (raw && looksLikeNetworkAddress(raw)) return `hosted at ${raw}`;
|
|
return null;
|
|
}
|