Files
PaperClipAI/packages/google-sheets-mcp-server/src/config.ts
T
DottaandPaperclip 7b35de65aa feat(mcp) [split 1/8]: add fixture demo servers (#9556)
## 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>
2026-07-14 12:56:21 -05:00

176 lines
5.9 KiB
TypeScript

import { readFileSync } from "node:fs";
import { isIP } from "node:net";
import { z } from "zod";
const serviceAccountSchema = z.object({
client_email: z.string().email(),
private_key: z.string().min(1),
project_id: z.string().optional(),
token_uri: z.string().optional(),
});
export type GoogleSheetsServiceAccount = z.infer<typeof serviceAccountSchema>;
export interface GoogleSheetsMcpConfig {
serviceAccount: GoogleSheetsServiceAccount;
allowedSpreadsheetIds: string[];
secretRedactions: string[];
}
export interface GoogleSheetsMcpHttpConfig {
mcpConfig: GoogleSheetsMcpConfig;
port: number;
host: string;
token: string | null;
}
export interface GoogleSheetsMcpConfigInput {
serviceAccountJson?: string | null;
serviceAccountJsonPath?: string | null;
allowedSpreadsheetIds?: string | string[] | null;
}
export interface GoogleSheetsMcpHttpConfigInput extends GoogleSheetsMcpConfigInput {
port?: string | number | null;
host?: string | null;
token?: string | null;
}
function parseArgs(argv: string[]): GoogleSheetsMcpConfigInput {
const input: GoogleSheetsMcpConfigInput = {};
for (let index = 0; index < argv.length; index += 1) {
const arg = argv[index];
const readValue = () => {
const next = argv[index + 1];
if (!next || next.startsWith("--")) {
throw new Error(`Missing value for ${arg}`);
}
index += 1;
return next;
};
if (arg === "--service-account-json") input.serviceAccountJson = readValue();
if (arg === "--service-account-json-path") input.serviceAccountJsonPath = readValue();
if (arg === "--allowed-spreadsheet-ids") input.allowedSpreadsheetIds = readValue();
}
return input;
}
function parseAllowedSpreadsheetIds(raw: string | string[] | null | undefined): string[] {
const values = Array.isArray(raw) ? raw : String(raw ?? "").split(/[\n,]/g);
const ids = values.map((value) => value.trim()).filter(Boolean);
return Array.from(new Set(ids));
}
function parsePort(raw: string | number | null | undefined): number {
if (raw === null || raw === undefined || raw === "") return 8849;
const port = typeof raw === "number" ? raw : Number.parseInt(raw, 10);
if (!Number.isInteger(port) || port < 0 || port > 65535) {
throw new Error(`Invalid port: ${raw}`);
}
return port;
}
function normalizeBindHost(raw: string | null | undefined): string {
return raw?.trim() || "127.0.0.1";
}
function isLoopbackBindHost(host: string): boolean {
const normalized = host.trim().toLowerCase().replace(/^\[(.*)\]$/, "$1");
if (normalized === "localhost" || normalized === "::1") return true;
if (isIP(normalized) === 4) {
return normalized.split(".")[0] === "127";
}
return false;
}
function readServiceAccountJson(input: GoogleSheetsMcpConfigInput): { raw: string; source: string } {
const explicitPath = input.serviceAccountJsonPath?.trim();
if (explicitPath) {
return { raw: readFileSync(explicitPath, "utf8"), source: explicitPath };
}
const inlineOrPath = input.serviceAccountJson?.trim();
if (!inlineOrPath) {
throw new Error(
"Google Sheets service-account credentials are required. Set GOOGLE_SHEETS_SERVICE_ACCOUNT_JSON or GOOGLE_SHEETS_SERVICE_ACCOUNT_JSON_PATH.",
);
}
if (inlineOrPath.startsWith("{")) {
return { raw: inlineOrPath, source: "inline JSON" };
}
return { raw: readFileSync(inlineOrPath, "utf8"), source: inlineOrPath };
}
export function createGoogleSheetsMcpConfig(input: GoogleSheetsMcpConfigInput): GoogleSheetsMcpConfig {
const allowedSpreadsheetIds = parseAllowedSpreadsheetIds(input.allowedSpreadsheetIds);
if (allowedSpreadsheetIds.length === 0) {
throw new Error("At least one allowed spreadsheet ID is required.");
}
const { raw, source } = readServiceAccountJson(input);
let parsed: unknown;
try {
parsed = JSON.parse(raw);
} catch {
throw new Error(`Invalid Google Sheets service-account JSON from ${source}.`);
}
const serviceAccount = serviceAccountSchema.parse(parsed);
return {
serviceAccount,
allowedSpreadsheetIds,
secretRedactions: [
raw,
serviceAccount.private_key,
serviceAccount.client_email,
].filter((value) => value.length >= 8),
};
}
export function createGoogleSheetsMcpHttpConfig(input: GoogleSheetsMcpHttpConfigInput): GoogleSheetsMcpHttpConfig {
const token = input.token?.trim();
const host = normalizeBindHost(input.host);
if (!token && !isLoopbackBindHost(host)) {
throw new Error("GOOGLE_SHEETS_MCP_TOKEN is required when GOOGLE_SHEETS_MCP_HOST is not loopback.");
}
return {
mcpConfig: createGoogleSheetsMcpConfig(input),
port: parsePort(input.port),
host,
token: token ? token : null,
};
}
export function readConfigFromEnv(
env: NodeJS.ProcessEnv = process.env,
argv: string[] = process.argv.slice(2),
): GoogleSheetsMcpConfig {
const args = parseArgs(argv);
return createGoogleSheetsMcpConfig({
serviceAccountJson: args.serviceAccountJson ?? env.GOOGLE_SHEETS_SERVICE_ACCOUNT_JSON,
serviceAccountJsonPath: args.serviceAccountJsonPath ?? env.GOOGLE_SHEETS_SERVICE_ACCOUNT_JSON_PATH,
allowedSpreadsheetIds: args.allowedSpreadsheetIds
?? env.GOOGLE_SHEETS_ALLOWED_SPREADSHEET_IDS
?? env.GOOGLE_SHEETS_SPREADSHEET_IDS,
});
}
export function readHttpConfigFromEnv(
env: NodeJS.ProcessEnv = process.env,
argv: string[] = process.argv.slice(2),
): GoogleSheetsMcpHttpConfig {
const args = parseArgs(argv);
return createGoogleSheetsMcpHttpConfig({
serviceAccountJson: args.serviceAccountJson ?? env.GOOGLE_SHEETS_SERVICE_ACCOUNT_JSON,
serviceAccountJsonPath: args.serviceAccountJsonPath ?? env.GOOGLE_SHEETS_SERVICE_ACCOUNT_JSON_PATH,
allowedSpreadsheetIds: args.allowedSpreadsheetIds
?? env.GOOGLE_SHEETS_ALLOWED_SPREADSHEET_IDS
?? env.GOOGLE_SHEETS_SPREADSHEET_IDS,
port: env.PORT ?? env.GOOGLE_SHEETS_MCP_PORT,
host: env.GOOGLE_SHEETS_MCP_HOST,
token: env.GOOGLE_SHEETS_MCP_TOKEN,
});
}