mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-29 12:59:13 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Apps connections give agents governed access to external services through vault credentials, grants, action policies, the tool gateway, and audit. > - Unikraft Cloud runs unikernel micro-VMs, services, and volumes across regional metros, and it offers a sandbox plugin for commands and files. > - Unikraft is not in the catalog. It has no hosted MCP server, so the generic "Connect your own MCP server" flow cannot reach it. > - Daytona (#16483) added a native REST pattern for this case: a catalog generated from the provider's published OpenAPI specifications and executed through the gateway. > - This pull request adds Unikraft on that pattern and moves the shared native-provider code into one registry, so the shared connection code does not name each provider. > - The benefit is governed agent access to all published Unikraft actions, with the token kept in the vault and sent only to published Unikraft hosts. ## Linked Issues or Issue Description Refs #16483 **Problem or motivation** Teams that run workloads on Unikraft Cloud want their agents to list instances, read logs, deploy and scale services, and run commands in sandboxes. Unikraft is not in the Apps catalog. Unikraft has no hosted MCP server, so operators cannot connect it through the remote MCP flow. **Proposed solution** Add a native Unikraft connection. Generate its actions from Unikraft's official OpenAPI specifications for the platform API and the sandbox plugin. Pin the specifications to a reviewed commit. The operator connects an API token. The token stays in the vault and goes only to the five published metro hosts. Every action takes an optional metro. Actions without a metro use the connection's default metro, which the operator can change under Advanced. **Alternatives considered** A catalog-only AppDefinition was not possible because no hosted MCP endpoint exists. Wrapping the `unikraft` CLI was rejected because it would expose host filesystem behavior and CLI login state. A second copy of the Daytona bridge was rejected; the shared transport and catalog contract are now one module with a provider registry. **Roadmap alignment** This extends the existing Apps and Connections provider coverage. It uses the existing credential, grant, policy, gateway, and audit model. It does not overlap planned core work. ## What Changed - Added `scripts/generate-unikraft-tools.mjs` and its tests. The generator reads the platform and sandbox plugin specifications at commit `5dd107ea1cd8716b83cb86a83ed2a6ee46f99b5b`, resolves shared parameters, records source SHA-256 hashes, and writes `server/src/services/unikraft/operations.generated.json`. - The catalog has 105 actions: 89 platform operations and 16 sandbox plugin operations. The server-sent audit event stream is recorded in the inventory and is not advertised as an action. - Classification: GET operations and sandbox reads and waits are reads. Delete, stop, suspend, detach, unpin, and sandbox command execution, signals, and stdin are destructive. All other operations are writes. - Added `server/src/services/connectors/unikraft/client.ts` and its generated catalog. It validates arguments against the generated schemas, accepts only published metros, rejects path traversal, sends JSON bodies on GET and DELETE as the specification requires, and verifies the token with `GET /v1/users/quotas`. A sandbox wait that times out (documented HTTP 408) returns a still-running result instead of a failure. - Moved the bounded, credential-redacting HTTP sender and the catalog contract helpers from `daytona.ts` to `native-rest-client.ts`. Added `native-provider-catalogs.ts`. `tool-access.ts`, the `tool-access/catalog` and `token-broker` modules, `connectors/tool-policy.ts`, and `tool-gateway.ts` now use this registry instead of Daytona-specific checks. Daytona behavior does not change. - Added the Unikraft definition source, the generated definition, the brand mark and manifest entry, and the permission review (`liveProof: not-run`). - Added `doc/connections/UNIKRAFT.md` with a sequence diagram, endpoints, setup, actions, and limits. Updated the connections README, the permission audit, and both capability maps. - Tests: definition shape, database-backed gateway reads, writes, deletes, and sandbox commands for personal and shared grants, default and per-call metros, rejection of unpublished metros and traversal, Off policies, revocation, stale-contract blocking, credential export denial, schema validation for all actions, pinned-transport tests for GET and DELETE bodies, and a browser setup check. ## Verification - `pnpm exec vitest run packages/shared/src server/src/__tests__/unikraft-connection.test.ts server/src/__tests__/unikraft-http-boundary.test.ts server/src/__tests__/daytona-connection.test.ts server/src/__tests__/daytona-http-boundary.test.ts server/src/__tests__/tool-access-service.test.ts server/src/__tests__/tool-gateway-service.test.ts server/src/__tests__/tool-gateway.test.ts ui/src/pages/apps/AppsConnect.test.tsx ui/src/pages/apps/Browse.test.tsx ui/src/lib/app-brand-assets.test.ts` plus `connector-tool-policy` and `tool-catalog-publication`: all passed after the rebase onto the split tool-access modules. - `node --test scripts/generate-unikraft-tools.test.mjs scripts/generate-daytona-tools.test.mjs scripts/app-brand-validation.test.mjs`: 20 passed. - `node scripts/check-app-brand-assets.mjs`, `node scripts/check-maps.mjs`, and `git diff --check`: passed. - `pnpm --filter @paperclipai/shared typecheck`, `pnpm --filter @paperclipai/server typecheck`, and `pnpm --filter @paperclipai/ui typecheck`: clean. - `npx playwright test --config tests/e2e/playwright.config.ts tests/e2e/unikraft-connector.spec.ts tests/e2e/daytona-connector.spec.ts`: 2 passed. - `node scripts/generate-unikraft-tools.mjs` regenerates the committed catalog with the recorded hashes. - Manual: on a local instance, open Connectors, search for Unikraft, and select **Add key**. Confirm the icon, the password field, the key guidance, and the default metro select under **Change**. - Not verified: a real Unikraft account. Live provider read and write proof is pending. ## Risks - A Unikraft token acts for the whole organization in every metro. Unikraft offers no narrower token permissions. Assign only trusted agents and review action permissions. - Sandbox actions run arbitrary commands inside the selected instance. They are classified as destructive. - A timed-out write can still complete at the provider. The bridge does not retry writes automatically. - New metros fail closed until the specification is regenerated and reviewed. Legacy `*.kraft.cloud` hosts are not reachable. - The Daytona refactor moves code without behavior changes. All Daytona tests pass without edits. - The generated JSON snapshot is large because it holds the provider input contracts. No migration or lockfile change is required. ## Model Used - Claude Opus 5.5 (Anthropic), model ID `claude-opus-5-5`, 1M context window, used through Claude Code with tool use (shell, file editing, web research, browser tests). ## 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
169 lines
8.7 KiB
TypeScript
169 lines
8.7 KiB
TypeScript
import Ajv, { type ValidateFunction } from "ajv";
|
|
import addFormats from "ajv-formats";
|
|
import { HttpError } from "../errors.js";
|
|
import { redactSensitiveText } from "../redaction.js";
|
|
import { descriptorHash, stableHash } from "./tool-catalog-hash.js";
|
|
|
|
/** Shared transport for native provider catalogs (Daytona, Unikraft). Each
|
|
* provider owns its endpoints and target checks; this owns the bounded,
|
|
* credential-redacting request/response handling they must all apply. */
|
|
export const NATIVE_REST_MAX_BYTES = 8 * 1024 * 1024;
|
|
export type NativeRestRequest = (url: string, init: RequestInit) => Promise<Response>;
|
|
|
|
export const nativeRestFailure = (status: number, code: string, message: string) => new HttpError(status, message, { code });
|
|
|
|
export function nativeRestRecord(value: unknown): Record<string, unknown> {
|
|
return value && typeof value === "object" && !Array.isArray(value) ? value as Record<string, unknown> : {};
|
|
}
|
|
|
|
export function nativeRestPathValue(value: unknown, invalid: () => Error) {
|
|
const text = String(value);
|
|
if (!text || text.length > 8192 || /[\u0000-\u001f\\]/.test(text)
|
|
|| text.split("/").some(segment => segment === "." || segment === "..")) {
|
|
throw invalid();
|
|
}
|
|
return encodeURIComponent(text);
|
|
}
|
|
|
|
export function nativeRestSender(options: {
|
|
/** Provider display name used in caller-facing messages. */
|
|
provider: string;
|
|
/** Error code prefix, such as `daytona`. */
|
|
code: string;
|
|
authorization: string;
|
|
request: NativeRestRequest;
|
|
signal: AbortSignal;
|
|
deadlineAt: number;
|
|
deniedMessage: string;
|
|
/** Provider-owned headers set after caller headers so they cannot be replaced. */
|
|
fixedHeaders?: Record<string, string>;
|
|
}) {
|
|
const { provider, code, authorization, request, signal, deadlineAt } = options;
|
|
const secret = authorization.replace(/^Bearer /, "");
|
|
const expired = () => nativeRestFailure(504, `${code}_deadline_exceeded`, `The ${provider} action deadline expired. An operation already sent may still be running; inspect it before retrying.`);
|
|
// Bound the caller even if a transport or body reader is slow to acknowledge
|
|
// cancellation. A late prerequisite result never advances to the next call.
|
|
async function withinDeadline<T>(work: () => Promise<T>): Promise<T> {
|
|
if (signal.aborted || Date.now() >= deadlineAt) throw expired();
|
|
let abort!: () => void;
|
|
try {
|
|
return await Promise.race([
|
|
Promise.resolve().then(() => { if (signal.aborted || Date.now() >= deadlineAt) throw expired(); return work(); }),
|
|
new Promise<never>((_resolve, reject) => {
|
|
abort = () => reject(expired());
|
|
signal.addEventListener("abort", abort, { once: true });
|
|
}),
|
|
]);
|
|
} finally { signal.removeEventListener("abort", abort); }
|
|
}
|
|
function sanitize(value: unknown): unknown {
|
|
if (typeof value === "string") return redactSensitiveText(value.split(secret).join("[REDACTED]"));
|
|
if (Array.isArray(value)) return value.map(sanitize);
|
|
if (value && typeof value === "object") return Object.fromEntries(Object.entries(value).map(([key, item]) => [key, sanitize(item)]));
|
|
return value;
|
|
}
|
|
|
|
/** `expectedStatuses` maps a provider-documented non-2xx outcome (for
|
|
* example, a wait that timed out) to the result returned in its place. */
|
|
async function send(url: string, init: RequestInit, extraHeaders: Record<string, string> = {},
|
|
expectedStatuses: Record<number, unknown> = {}): Promise<unknown> {
|
|
const projected = new Headers(init.headers);
|
|
projected.set("Authorization", authorization);
|
|
for (const [name, value] of Object.entries({ ...options.fixedHeaders, ...extraHeaders })) projected.set(name, value);
|
|
let response: Response;
|
|
try {
|
|
response = await withinDeadline(() => request(url, { ...init, redirect: "error", headers: Object.fromEntries(projected), signal }));
|
|
} catch {
|
|
if (signal.aborted || Date.now() >= deadlineAt) throw expired();
|
|
throw nativeRestFailure(502, `${code}_outcome_unknown`, init.method === "GET"
|
|
? `${provider} could not complete the request.`
|
|
: `${provider} did not return a result. The operation may have started; inspect its state before retrying.`);
|
|
}
|
|
if (Object.hasOwn(expectedStatuses, response.status)) {
|
|
void response.body?.cancel().catch(() => {});
|
|
return expectedStatuses[response.status];
|
|
}
|
|
if (!response.ok) {
|
|
void response.body?.cancel().catch(() => {});
|
|
const status = [400, 401, 403, 404, 409, 422, 429].includes(response.status) ? response.status : 502;
|
|
throw nativeRestFailure(status, `${code}_request_failed`, status === 401 || status === 403
|
|
? options.deniedMessage
|
|
: status === 404 ? `${provider} could not find this resource.` : `${provider} could not complete this operation.`);
|
|
}
|
|
if (response.status === 204 || !response.body) return null;
|
|
const reader = response.body.getReader();
|
|
const chunks: Uint8Array[] = [];
|
|
let length = 0;
|
|
try {
|
|
for (;;) {
|
|
const part = await withinDeadline(() => reader.read());
|
|
if (part.done) break;
|
|
length += part.value.byteLength;
|
|
if (length > NATIVE_REST_MAX_BYTES) throw nativeRestFailure(502, `${code}_output_limit`, `${provider}'s response exceeded the limit. Request a smaller page or file range.`);
|
|
chunks.push(part.value);
|
|
}
|
|
} catch (error) {
|
|
if (error instanceof HttpError) throw error;
|
|
throw nativeRestFailure(502, `${code}_outcome_unknown`, `${provider}'s response was interrupted. Inspect the operation before retrying.`);
|
|
} finally { void reader.cancel().catch(() => {}); }
|
|
const bytes = Buffer.concat(chunks);
|
|
if (!bytes.length) return null;
|
|
const contentType = response.headers.get("Content-Type") ?? "application/octet-stream";
|
|
if (contentType.includes("json")) {
|
|
try { return sanitize(JSON.parse(bytes.toString("utf8"))); }
|
|
catch { throw nativeRestFailure(502, `${code}_invalid_response`, `${provider} returned an invalid response.`); }
|
|
}
|
|
if (contentType.startsWith("text/")) return sanitize(bytes.toString("utf8"));
|
|
if (bytes.includes(Buffer.from(secret))) throw nativeRestFailure(403, `${code}_credential_export_denied`, "The response contains connection credential material.");
|
|
return { contentType, contentBase64: bytes.toString("base64"), byteLength: bytes.length };
|
|
}
|
|
|
|
return { send, withinDeadline };
|
|
}
|
|
|
|
type NativeOperation = {
|
|
name: string; title: string; description: string; inputSchema: unknown;
|
|
annotations: { readOnlyHint: boolean; destructiveHint: boolean; idempotentHint?: boolean; openWorldHint?: boolean };
|
|
};
|
|
export type NativeCatalogEntry = { toolName: string; versionHash: string; schemaHash: string | null; riskLevel: string };
|
|
|
|
// Match the interop used by the existing plugin configuration validator.
|
|
const AjvCtor = (Ajv as any).default ?? Ajv;
|
|
const ajv = new AjvCtor({ strict: false, allErrors: true, validateFormats: true });
|
|
((addFormats as any).default ?? addFormats)(ajv);
|
|
|
|
/** The deployed contract of a generated provider catalog: agent-visible tools,
|
|
* reviewed risk, saved-entry staleness and argument validation. */
|
|
export function nativeCatalog<T extends NativeOperation>(operationsList: T[]) {
|
|
const operations = new Map(operationsList.map(operation => [operation.name, operation]));
|
|
const validators = new Map<string, ValidateFunction>();
|
|
const risk = (name: string): "read" | "write" | "destructive" => {
|
|
const operation = operations.get(name);
|
|
if (!operation || operation.annotations.destructiveHint) return "destructive";
|
|
return operation.annotations.readOnlyHint ? "read" : "write";
|
|
};
|
|
const tools = operationsList.map(({ name, title, description, inputSchema, annotations }) => ({
|
|
name, title, description, inputSchema: inputSchema as Record<string, unknown>, annotations,
|
|
}));
|
|
const contracts = new Map(tools.map(tool => [tool.name, {
|
|
versionHash: descriptorHash(tool, risk(tool.name)), schemaHash: stableHash(tool.inputSchema), riskLevel: risk(tool.name),
|
|
}]));
|
|
return {
|
|
tools,
|
|
operation: (name: string) => operations.get(name),
|
|
isToolName: (name: string) => operations.has(name),
|
|
risk,
|
|
isCurrentEntry(entry: NativeCatalogEntry): boolean {
|
|
const current = contracts.get(entry.toolName);
|
|
return Boolean(current && current.versionHash === entry.versionHash && current.schemaHash === entry.schemaHash && current.riskLevel === entry.riskLevel);
|
|
},
|
|
validate(name: string, parameters: unknown): boolean {
|
|
const operation = operations.get(name);
|
|
if (!operation) return false;
|
|
let validate = validators.get(name);
|
|
if (!validate) { validate = ajv.compile(operation.inputSchema as object) as ValidateFunction; validators.set(name, validate); }
|
|
return validate(parameters) as boolean;
|
|
},
|
|
};
|
|
}
|