mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-10-13 04:02:28 +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 1/8 and focuses on fixture and demo MCP servers > - 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: Developers need deterministic local MCP fixtures and visible demo servers without pulling in the governed production runtime. - Proposed solution: Adds the Google Sheets and KV demo MCP packages, fixture catalog/servers, smoke harness, guide, and the root smoke/typecheck registration hunks. - 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 `master`. - 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 fixture and smoke coverage; Greptile on every PR. ## What Changed - Adds the Google Sheets and KV demo MCP packages, fixture catalog/servers, smoke harness, guide, and the root smoke/typecheck registration hunks. - 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 --filter @paperclipai/google-sheets-mcp-server test` — 27 tests passed - `pnpm --filter @paperclipai/kv-demo-mcp-server test` — 12 tests passed ## Risks - The new packages add dependencies that are intentionally not committed to `pnpm-lock.yaml`, per repository policy. - 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>
162 lines
5.2 KiB
TypeScript
162 lines
5.2 KiB
TypeScript
import { Client } from "@modelcontextprotocol/sdk/client/index.js";
|
|
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js";
|
|
import { afterEach, describe, expect, it, vi } from "vitest";
|
|
import { createGoogleSheetsMcpHttpServer, type GoogleSheetsMcpHttpServer } from "./http.js";
|
|
import type { GoogleSheetsMcpConfig } from "./config.js";
|
|
import type { GoogleSheetsClient } from "./google-client.js";
|
|
|
|
const expectedTools = [
|
|
"list_spreadsheets",
|
|
"get_spreadsheet_info",
|
|
"read_values",
|
|
"search_rows",
|
|
"append_rows",
|
|
"update_values",
|
|
"add_sheet_tab",
|
|
"clear_values",
|
|
"delete_rows",
|
|
];
|
|
|
|
const servers: GoogleSheetsMcpHttpServer[] = [];
|
|
|
|
function makeConfig(): GoogleSheetsMcpConfig {
|
|
return {
|
|
serviceAccount: {
|
|
client_email: "service@example.test",
|
|
private_key: "-----BEGIN PRIVATE KEY-----\nfake\n-----END PRIVATE KEY-----",
|
|
},
|
|
allowedSpreadsheetIds: ["sheet-1"],
|
|
secretRedactions: ["service@example.test", "-----BEGIN PRIVATE KEY-----\nfake\n-----END PRIVATE KEY-----"],
|
|
};
|
|
}
|
|
|
|
function makeClient(): GoogleSheetsClient {
|
|
return {
|
|
listSpreadsheets: vi.fn().mockResolvedValue([
|
|
{ spreadsheetId: "sheet-1", title: "Budget", spreadsheetUrl: "https://docs.google.com/spreadsheets/d/sheet-1" },
|
|
]),
|
|
getSpreadsheetInfo: vi.fn().mockResolvedValue({
|
|
spreadsheetId: "sheet-1",
|
|
title: "Budget",
|
|
spreadsheetUrl: "https://docs.google.com/spreadsheets/d/sheet-1",
|
|
sheets: [],
|
|
}),
|
|
readValues: vi.fn().mockResolvedValue({
|
|
spreadsheetId: "sheet-1",
|
|
range: "Sheet1!A1:B2",
|
|
values: [["name", "amount"], ["paper", 12]],
|
|
}),
|
|
searchRows: vi.fn().mockResolvedValue({
|
|
spreadsheetId: "sheet-1",
|
|
range: "Sheet1!A1:B2",
|
|
query: "paper",
|
|
matches: [{ rowIndex: 2, values: ["paper", 12] }],
|
|
}),
|
|
appendRows: vi.fn().mockResolvedValue({ spreadsheetId: "sheet-1", range: "Sheet1!A:B", updatedRows: 1 }),
|
|
updateValues: vi.fn().mockResolvedValue({ spreadsheetId: "sheet-1", range: "Sheet1!A2:B2", updatedRows: 1 }),
|
|
addSheetTab: vi.fn().mockResolvedValue({
|
|
spreadsheetId: "sheet-1",
|
|
sheet: { sheetId: 1, title: "New", index: 1, rowCount: null, columnCount: null },
|
|
}),
|
|
clearValues: vi.fn().mockResolvedValue({ spreadsheetId: "sheet-1", range: "Sheet1!A2:B2" }),
|
|
deleteRows: vi.fn().mockResolvedValue({ spreadsheetId: "sheet-1", sheetId: 0, deletedRows: 1 }),
|
|
};
|
|
}
|
|
|
|
async function startServer(token?: string) {
|
|
const googleClient = makeClient();
|
|
const instance = createGoogleSheetsMcpHttpServer({
|
|
config: makeConfig(),
|
|
client: googleClient,
|
|
token,
|
|
});
|
|
const port = await instance.listen(0, "127.0.0.1");
|
|
servers.push(instance);
|
|
return { googleClient, base: `http://127.0.0.1:${port}` };
|
|
}
|
|
|
|
async function mcpClient(base: string, headers?: Record<string, string>, path = "/mcp") {
|
|
const transport = new StreamableHTTPClientTransport(new URL(`${base}${path}`), {
|
|
requestInit: headers ? { headers } : undefined,
|
|
});
|
|
const client = new Client({ name: "test", version: "0.0.0" });
|
|
await client.connect(transport);
|
|
return client;
|
|
}
|
|
|
|
afterEach(async () => {
|
|
while (servers.length) {
|
|
const instance = servers.pop();
|
|
if (instance) await instance.close();
|
|
}
|
|
});
|
|
|
|
describe("Google Sheets MCP HTTP server", () => {
|
|
it("supports tools/list in unauthenticated loopback mode", async () => {
|
|
const { base } = await startServer();
|
|
const client = await mcpClient(base);
|
|
|
|
try {
|
|
const list = await client.listTools();
|
|
expect(list.tools.map((tool) => tool.name)).toEqual(expectedTools);
|
|
} finally {
|
|
await client.close();
|
|
}
|
|
});
|
|
|
|
it("supports tools/call with the mocked Google client", async () => {
|
|
const { base, googleClient } = await startServer();
|
|
const client = await mcpClient(base);
|
|
|
|
try {
|
|
const result = await client.callTool({
|
|
name: "read_values",
|
|
arguments: {
|
|
spreadsheetId: "sheet-1",
|
|
range: "Sheet1!A1:B2",
|
|
},
|
|
});
|
|
|
|
expect(googleClient.readValues).toHaveBeenCalledWith("sheet-1", "Sheet1!A1:B2");
|
|
expect(result.content).toEqual([
|
|
expect.objectContaining({
|
|
type: "text",
|
|
text: expect.stringContaining("paper"),
|
|
}),
|
|
]);
|
|
} finally {
|
|
await client.close();
|
|
}
|
|
});
|
|
|
|
it("requires GOOGLE_SHEETS_MCP_TOKEN when configured", async () => {
|
|
const token = "sheets-local-token";
|
|
const { base, googleClient } = await startServer(token);
|
|
|
|
expect((await fetch(`${base}/mcp`)).status).toBe(401);
|
|
expect((await fetch(`${base}/mcp?token=${token}`)).status).toBe(401);
|
|
|
|
const client = await mcpClient(base, { authorization: `Bearer ${token}` });
|
|
try {
|
|
await client.callTool({
|
|
name: "append_rows",
|
|
arguments: {
|
|
spreadsheetId: "sheet-1",
|
|
range: "Sheet1!A:B",
|
|
values: [["paper", 12]],
|
|
valueInputOption: "RAW",
|
|
},
|
|
});
|
|
|
|
expect(googleClient.appendRows).toHaveBeenCalledWith({
|
|
spreadsheetId: "sheet-1",
|
|
range: "Sheet1!A:B",
|
|
values: [["paper", 12]],
|
|
valueInputOption: "RAW",
|
|
});
|
|
} finally {
|
|
await client.close();
|
|
}
|
|
});
|
|
});
|