mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-16 11:59:26 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work. > - Agents use connected apps through MCP. Paperclip already hosts MCP Apps views and speaks stateless MCP 2026-07-28. > - The MCP Skills extension (SEP-2640, Final) lets an app publish skills (instructions and files) next to its tools. Hugging Face already serves 25. > - Paperclip did not read them, so agents missed each app's own workflow guidance. > - Skills are a prompt-injection surface. The spec makes manifest binding, verification, origin tagging and approval revocation host requirements. > - This pull request makes Paperclip a Skills host: discover, review, verify, and deliver app skills to the agents that use the app. > - The benefit is that connected apps can teach agents their workflows, under board control. ## Linked Issues or Issue Description **Problem** Connected MCP servers can publish skills with the `io.modelcontextprotocol/skills` extension. Paperclip ignored them. A board could not see, review or approve them, and agents never received them. **Proposed solution** Implement the host side of SEP-2640. List skills during catalog refresh, record them per connection and company, bind board approval to the full file manifest, and load approved skills into agent runs with verified, lazily fetched content. **Why it matters** Apps ship workflow guidance with their tools. Without the extension, each team must copy that guidance into company skills by hand, and it goes stale. Refs #21119, Refs #21140 (the MCP Apps and stateless MCP client work this builds on). ## What Changed - **Client capability.** Every stateless request declares `io.modelcontextprotocol/skills`. Legacy handshake sessions do not. The capabilities that `server/discover` advertises are remembered beside the protocol era. - **Discovery.** Catalog refresh calls `skills/list` (paged) only when the server declared the extension. A listing inside its `ttlMs` is reused. A skills failure never fails the tool refresh. Nothing runs while a run starts. - **Schema.** New `tool_mcp_skills` (company, connection, skill URI; frontmatter, sorted manifest, manifest digest, review state) and `tool_mcp_skill_files` (verified bytes keyed by connection, URI and digest). Both cascade with the connection. - **Governance.** New skills wait for review. Approval binds to the order-free digest of every `{uri, digest, size}`; a request for any other digest gets 409. A changed manifest or frontmatter revokes approval and logs `tool_mcp_skill.approval_revoked`. Dynamic, oversized and invalid skills are declined with a reason. Approve and decline use the company skill policy (`skills.install`, `external_package`, `mcp-connection:<id>`). - **Run time.** Approved skills of connections the agent can use load in parallel with other skill preparation, inside a 3 s budget. `SKILL.md` is read with the agent's grant and checked for size, SHA-256 and frontmatter. A failure calls `skills/get` and takes the skill out of use. Each skill becomes a per-run bundle on the connector skill path, named in its app's namespace, tagged with its origin. Paperclip writes the frontmatter: `allowed-tools` only if the board approved it. - **Supporting files.** `GET /api/agents/me/mcp-skills/:skillId/files?path=` serves manifest-listed files to an agent in an active run, through the skill's own connection. The sandbox bridge allows the route. - **Board API and UI.** `GET/POST /api/companies/:companyId/mcp-skills…` (list, read instructions, approve, decline). The Skills page shows "Skills from connected apps" with app, state, size, requested tools and plain-language notes. It renders nothing when no app publishes skills. - **Docs.** `doc/connections/MCP-SKILLS.md`, linked from `doc/connections/README.md`. - **Shared frontmatter parser.** It now decodes YAML single-quoted scalars. Before, 5 of Hugging Face's 25 skills kept their quotes and would fail the frontmatter check; now all 25 match. The generated runner copy is regenerated. File size notes: `server/src/services/tool-gateway.ts` grows by about 200 lines. The run-time reads must use its grant resolution and `callAssignedConnectionProtocol`, like MCP Apps view reads. Splitting the gateway is a separate refactor. `CompanySkills.tsx` and `CompanySkills.production.tsx` gain 2–4 lines each; the section lives in its own component. ## Verification - `server/src/__tests__/mcp-skills.test.ts` (15 tests) uses a fake stateless skills server and embedded Postgres. It covers: discovery only after the server declares the extension; the capability in `_meta`; `ttlMs` reuse; lazy fetch (no reads at listing or approval; `SKILL.md` at load; supporting files on read); a stale-digest approval refused; a reorder that keeps approval; a changed or added file that revokes it; dynamic skills declined; a same-size tampered `SKILL.md` rejected, refreshed with `skills/get`, and taken out of use; mismatched frontmatter rejected; reads outside the manifest refused; the same URI and name from two servers kept apart; company scoping; a slow app skipped within the budget and cached later; HTTP authorization (board only, agent needs an active run, run header must match) and activity logging. - Red/green: with the digest check disabled, the tamper test fails; with the manifest comparison disabled, the revocation test fails. Both pass with the code. - `server/src/__tests__/mcp-protocol-versions.test.ts`, `mcp-apps.test.ts`, `connection-instructions.test.ts`, `tool-gateway-discovery-http.test.ts`: 47 pass (two capability assertions updated for the new extension). - `packages/shared/src/frontmatter.test.ts` adds a single-quoted scalar case; the runner contract test passes (23 tests). - `ui/src/components/skills/ConnectedAppSkills.test.tsx` (3) and `ui/src/pages/CompanySkills.test.tsx` (44) pass. `packages/adapter-utils/src/sandbox-callback-bridge.test.ts` (89) passes. - `pnpm --filter @paperclipai/server typecheck` passes. UI `tsc` passes except the known missing generated Storybook catalog files. - `pnpm verify` returned exit 2 (doc change is a global CI input); required CI supplies broad coverage. - Live check against `https://huggingface.co/mcp` without credentials, through Paperclip's own services and the real egress guard: 25 skills discovered as pending; three approved; cold load 135 ms, cached load 13 ms; a supporting file read through the manifest; the bundle tagged with its origin. - Storybook: `Agents and reusable capabilities/Skills and Skill Studio/Connected app skills` (needs review, all states, tool request, name collision, reading instructions). ## Risks - **Migration:** two new tables only. No changes to existing tables. Safe with the previous release running. - **Run start:** companies without an approved app skill pay one indexed read. With approved skills the wait is capped at 3 s; late or failing skills are left out with a `skills.mcp_unavailable` run warning and never fail the run. - **Agent harness enforcement:** Paperclip cannot gate each code-execution tool call an agent makes while following an app's skill. Approval is explicit and per skill, the approval note says agents may run commands the skill describes, and `allowed-tools` is never granted without a separate tick. - **Shared-home adapters** receive app skills like company skills. A revoked skill leaves on the next skill sync. - Not in this PR: per-connection opt-in for dynamic skills; serving Paperclip's own skills from its public MCP endpoint; `resources/directory/read`; app skills on an agent's skills tab. ## Model Used - Claude Opus 5.5 (`claude-opus-5-5`), Anthropic, via Claude Code with tool use (shell, file edits, local test runs, live HTTP checks). Extended reasoning 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] 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 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
351 lines
10 KiB
TypeScript
351 lines
10 KiB
TypeScript
import fs from "node:fs";
|
|
import path from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
import { describe, expect, it } from "vitest";
|
|
import {
|
|
analyzeFrontmatterBlock,
|
|
detectFrontmatterRoundTripIssues,
|
|
getSkillFrontmatterUnknownKeys,
|
|
joinFrontmatterBlock,
|
|
parseFrontmatterFields,
|
|
parseFrontmatterMarkdown,
|
|
skillFrontmatterSchema,
|
|
splitFrontmatterBlock,
|
|
stringifyFrontmatter,
|
|
} from "./frontmatter.js";
|
|
|
|
const repoRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), "../../..");
|
|
const skillMarkdownSearchRoots = [
|
|
"packages/skills-catalog/catalog",
|
|
"packages/teams-catalog/catalog",
|
|
"packages/adapters/hermes/skills",
|
|
"packages/plugins/plugin-llm-wiki/skills",
|
|
"skills",
|
|
];
|
|
|
|
describe("parseFrontmatterMarkdown", () => {
|
|
it("parses folded and literal YAML block scalars", () => {
|
|
const folded = parseFrontmatterMarkdown([
|
|
"---",
|
|
"name: Folded",
|
|
"description: >",
|
|
" First line",
|
|
" second line",
|
|
"",
|
|
" Third paragraph",
|
|
"---",
|
|
"",
|
|
"Body",
|
|
].join("\n"));
|
|
|
|
expect(folded.frontmatter.description).toBe("First line second line\n\nThird paragraph\n");
|
|
|
|
const literal = parseFrontmatterMarkdown([
|
|
"---",
|
|
"name: Literal",
|
|
"description: |",
|
|
" First line",
|
|
" second line",
|
|
"---",
|
|
"",
|
|
"Body",
|
|
].join("\n"));
|
|
|
|
expect(literal.frontmatter.description).toBe("First line\nsecond line\n");
|
|
});
|
|
|
|
it("decodes single-quoted scalars, as published MCP skills use them", () => {
|
|
const parsed = parseFrontmatterMarkdown("---\nname: env-setup\ndescription: 'Set up the \"environment\". Don''t use system Python.'\n---\n\nBody\n");
|
|
expect(parsed.frontmatter).toEqual({ name: "env-setup", description: "Set up the \"environment\". Don't use system Python." });
|
|
});
|
|
|
|
it("respects block-scalar chomping indicators", () => {
|
|
const foldedStrip = parseFrontmatterMarkdown([
|
|
"---",
|
|
"description: >-",
|
|
" First line",
|
|
" second line",
|
|
"",
|
|
" Third paragraph",
|
|
"---",
|
|
"",
|
|
"Body",
|
|
].join("\n"));
|
|
|
|
expect(foldedStrip.frontmatter.description).toBe("First line second line\n\nThird paragraph");
|
|
|
|
const literalKeep = parseFrontmatterMarkdown([
|
|
"---",
|
|
"description: |+",
|
|
" First line",
|
|
" second line",
|
|
"",
|
|
"",
|
|
"---",
|
|
"",
|
|
"Body",
|
|
].join("\n"));
|
|
|
|
expect(literalKeep.frontmatter.description).toBe("First line\nsecond line\n\n");
|
|
});
|
|
|
|
it("parses inline object array items nested under frontmatter keys", () => {
|
|
const parsed = parseFrontmatterMarkdown([
|
|
"---",
|
|
"metadata:",
|
|
" sources:",
|
|
" - kind: github-dir",
|
|
" repo: paperclipai/paperclip",
|
|
" path: skills/paperclip",
|
|
"---",
|
|
"",
|
|
"Body",
|
|
].join("\n"));
|
|
|
|
expect(parsed.frontmatter).toMatchObject({
|
|
metadata: {
|
|
sources: [
|
|
{
|
|
kind: "github-dir",
|
|
repo: "paperclipai/paperclip",
|
|
path: "skills/paperclip",
|
|
},
|
|
],
|
|
},
|
|
});
|
|
});
|
|
|
|
it("does not treat trailing-dot decimals as numbers", () => {
|
|
const parsed = parseFrontmatterMarkdown([
|
|
"---",
|
|
"version: 1.",
|
|
"---",
|
|
"",
|
|
].join("\n"));
|
|
|
|
expect(parsed.frontmatter.version).toBe("1.");
|
|
});
|
|
});
|
|
|
|
describe("splitFrontmatterBlock", () => {
|
|
it("splits every bundled skill markdown file without losing bytes", () => {
|
|
const skillMarkdownFiles = collectSkillMarkdownFiles();
|
|
|
|
expect(skillMarkdownFiles.length).toBeGreaterThan(0);
|
|
for (const filePath of skillMarkdownFiles) {
|
|
const raw = fs.readFileSync(filePath, "utf8");
|
|
const split = splitFrontmatterBlock(raw);
|
|
const joined = split.hasFrontmatter
|
|
? `---\n${split.frontmatterText}\n---\n${split.body}`
|
|
: split.body;
|
|
|
|
expect(joined, path.relative(repoRoot, filePath)).toBe(raw);
|
|
}
|
|
});
|
|
|
|
it("leaves files without frontmatter untouched", () => {
|
|
const raw = "Body starts immediately.\n\n---\nThis is not frontmatter.\n";
|
|
const split = splitFrontmatterBlock(raw);
|
|
|
|
expect(split).toEqual({
|
|
frontmatterText: "",
|
|
body: raw,
|
|
hasFrontmatter: false,
|
|
});
|
|
});
|
|
|
|
it("treats an empty opening block as frontmatter", () => {
|
|
const raw = "---\n---\nBody\n";
|
|
|
|
expect(splitFrontmatterBlock(raw)).toEqual({
|
|
frontmatterText: "",
|
|
body: "Body\n",
|
|
hasFrontmatter: true,
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("stringifyFrontmatter", () => {
|
|
it.each([
|
|
{
|
|
label: "nested metadata",
|
|
value: {
|
|
name: "demo-skill",
|
|
description: "Demo skill",
|
|
metadata: {
|
|
source: {
|
|
kind: "github-dir",
|
|
repo: "paperclipai/paperclip",
|
|
path: "skills/paperclip",
|
|
},
|
|
},
|
|
},
|
|
},
|
|
{
|
|
label: "arrays",
|
|
value: {
|
|
name: "tool-skill",
|
|
description: "Tool skill",
|
|
"allowed-tools": ["Read", "Write", "Bash"],
|
|
tags: ["skills", "frontmatter"],
|
|
},
|
|
},
|
|
{
|
|
label: "block scalars",
|
|
value: {
|
|
name: "block-skill",
|
|
description: "First line\nsecond line\n\nThird paragraph\n",
|
|
metadata: {
|
|
notes: "Keep\nall\nline breaks",
|
|
},
|
|
},
|
|
},
|
|
])("serializes parser-compatible YAML for $label", ({ value }) => {
|
|
const first = parseFrontmatterMarkdown(`---\n${stringifyFrontmatter(value)}\n---\n`).frontmatter;
|
|
const second = parseFrontmatterMarkdown(`---\n${stringifyFrontmatter(first)}\n---\n`).frontmatter;
|
|
|
|
expect(second).toEqual(first);
|
|
});
|
|
});
|
|
|
|
describe("skillFrontmatterSchema", () => {
|
|
it("validates core skill frontmatter fields while allowing unknown keys", () => {
|
|
const parsed = skillFrontmatterSchema.parse({
|
|
name: "demo-skill",
|
|
description: "A demo skill.",
|
|
"allowed-tools": ["Read", "Write"],
|
|
metadata: { nested: { enabled: true } },
|
|
tags: ["demo"],
|
|
});
|
|
|
|
expect(parsed.tags).toEqual(["demo"]);
|
|
expect(getSkillFrontmatterUnknownKeys(parsed)).toEqual(["tags"]);
|
|
});
|
|
|
|
it("rejects non-slug skill names", () => {
|
|
expect(() => skillFrontmatterSchema.parse({
|
|
name: "Demo Skill",
|
|
description: "A demo skill.",
|
|
})).toThrow();
|
|
});
|
|
});
|
|
|
|
describe("detectFrontmatterRoundTripIssues", () => {
|
|
it("reports YAML constructs that fields mode cannot preserve", () => {
|
|
const issues = detectFrontmatterRoundTripIssues([
|
|
"# leading comment",
|
|
"\"quoted-key\": value",
|
|
"base: &base",
|
|
"copy: *base",
|
|
].join("\n"));
|
|
|
|
expect(issues.map((issue) => issue.kind)).toEqual([
|
|
"comment",
|
|
"quoted_key",
|
|
"anchor",
|
|
"alias",
|
|
]);
|
|
});
|
|
});
|
|
|
|
describe("joinFrontmatterBlock", () => {
|
|
it("is the exact inverse of splitFrontmatterBlock (byte-identity round-trip)", () => {
|
|
const samples = [
|
|
"---\nname: reflection-coach\ndescription: A coach\n---\n# Body\n\nHello\n",
|
|
"---\nname: x\n---\nno trailing newline",
|
|
"---\nname: x\n---\n", // empty body
|
|
"---\ndescription: >\n folded\n text\n---\nBody with comment: value\n",
|
|
"# just markdown, no frontmatter\n",
|
|
"---\nunterminated frontmatter\nstill body",
|
|
"---\nmetadata:\n author: Paperclip\n # comment stays\n---\nbody\n",
|
|
];
|
|
for (const raw of samples) {
|
|
expect(joinFrontmatterBlock(splitFrontmatterBlock(raw))).toBe(raw);
|
|
}
|
|
});
|
|
|
|
it("returns the body untouched when there is no frontmatter", () => {
|
|
expect(
|
|
joinFrontmatterBlock({ frontmatterText: "", body: "just body", hasFrontmatter: false }),
|
|
).toBe("just body");
|
|
});
|
|
});
|
|
|
|
describe("parseFrontmatterFields", () => {
|
|
it("parses the raw block text into an object and is lenient on garbage", () => {
|
|
expect(parseFrontmatterFields("name: foo\ndescription: bar")).toEqual({
|
|
name: "foo",
|
|
description: "bar",
|
|
});
|
|
expect(parseFrontmatterFields("")).toEqual({});
|
|
expect(parseFrontmatterFields("# only a comment")).toEqual({});
|
|
});
|
|
});
|
|
|
|
describe("analyzeFrontmatterBlock", () => {
|
|
it("marks a simple inline block as round-trippable", () => {
|
|
const result = analyzeFrontmatterBlock("name: reflection-coach\ndescription: A coach");
|
|
expect(result.canRoundTrip).toBe(true);
|
|
expect(result.issues).toEqual([]);
|
|
expect(result.parsed).toEqual({ name: "reflection-coach", description: "A coach" });
|
|
});
|
|
|
|
it("marks a block with allowed-tools and metadata as round-trippable", () => {
|
|
const raw = [
|
|
"name: coach",
|
|
"description: A coach",
|
|
"allowed-tools:",
|
|
" - Read",
|
|
" - Grep",
|
|
"metadata:",
|
|
" author: Paperclip",
|
|
" version: 2",
|
|
].join("\n");
|
|
const result = analyzeFrontmatterBlock(raw);
|
|
expect(result.canRoundTrip).toBe(true);
|
|
expect(result.parsed["allowed-tools"]).toEqual(["Read", "Grep"]);
|
|
});
|
|
|
|
it("refuses fields mode when comments are present (would be dropped)", () => {
|
|
const result = analyzeFrontmatterBlock("name: coach # inline note\ndescription: x");
|
|
expect(result.canRoundTrip).toBe(false);
|
|
expect(result.issues.some((issue) => issue.kind === "comment")).toBe(true);
|
|
});
|
|
|
|
it("refuses fields mode for folded scalars the serializer cannot reproduce", () => {
|
|
const raw = ["description: >", " first line", " second line"].join("\n");
|
|
const result = analyzeFrontmatterBlock(raw);
|
|
// No detector "issue", but re-serialization is not byte-identical, so it is
|
|
// still not round-trippable — the strict serialize-back gate catches it.
|
|
expect(result.canRoundTrip).toBe(false);
|
|
});
|
|
|
|
it("treats an empty block as round-trippable", () => {
|
|
const result = analyzeFrontmatterBlock("");
|
|
expect(result.canRoundTrip).toBe(true);
|
|
expect(result.parsed).toEqual({});
|
|
});
|
|
});
|
|
|
|
function collectSkillMarkdownFiles() {
|
|
return skillMarkdownSearchRoots.flatMap((relativeRoot) => {
|
|
const absoluteRoot = path.join(repoRoot, relativeRoot);
|
|
return fs.existsSync(absoluteRoot) ? collectSkillMarkdownFilesUnder(absoluteRoot) : [];
|
|
}).sort();
|
|
}
|
|
|
|
function collectSkillMarkdownFilesUnder(root: string): string[] {
|
|
const files: string[] = [];
|
|
for (const entry of fs.readdirSync(root, { withFileTypes: true })) {
|
|
const absolutePath = path.join(root, entry.name);
|
|
if (entry.isDirectory()) {
|
|
files.push(...collectSkillMarkdownFilesUnder(absolutePath));
|
|
continue;
|
|
}
|
|
if (entry.isFile() && entry.name === "SKILL.md") {
|
|
files.push(absolutePath);
|
|
}
|
|
}
|
|
return files;
|
|
}
|