mirror of
https://github.com/AmruthPillai/Reactive-Resume.git
synced 2026-08-24 23:32:19 +10:00
refactor(mcp): derive tool metadata from single TOOL_META record
- Extract one TOOL_META record (title/description/inputSchema/annotations per tool) consumed by both registerTools and buildMcpServerCard, eliminating the ~200-line duplication in the server card. - Collapse TOOL_ANNOTATIONS from 14 × 4-line inline objects to 5 named annotation-preset consts (READ_IDEMPOTENT, WRITE_NON_IDEMPOTENT, etc.), saving ~55 lines. Claude-Session: https://claude.ai/code/session_012Bnvt1MghwHj4qQRxuQUGa
This commit is contained in:
Amruth Pillai
@@ -0,0 +1,237 @@
|
||||
/**
|
||||
* Canonical tool metadata (title, description, inputSchema, annotations) declared once.
|
||||
* Consumed by both `registerTools` (raw Zod) and `buildMcpServerCard` (toJsonSchemaCompat).
|
||||
*/
|
||||
import z from "zod";
|
||||
import { resumePatchOperationsSchema } from "@reactive-resume/ai/tools/resume-tool-contracts";
|
||||
import { MCP_TOOL_NAME as T } from "./mcp-tool-names";
|
||||
import { TOOL_ANNOTATIONS } from "./tool-annotations";
|
||||
|
||||
// ponytail: shared schema fragment; exported so server-card can re-use without re-importing
|
||||
export const resumeIdSchema = z.string().min(1).describe(`Resume ID. Use \`${T.listResumes}\` to find valid IDs.`);
|
||||
|
||||
export const TOOL_META = {
|
||||
[T.listResumes]: {
|
||||
title: "List Resumes",
|
||||
description: [
|
||||
"Primary way to discover resume IDs for this account. Resumes are not listed as MCP resources;",
|
||||
"use this tool (not `resources/list`) to enumerate IDs.",
|
||||
"",
|
||||
"Returns an array of resume objects (without full resume data) containing:",
|
||||
"id, name, slug, tags, isPublic, isLocked, createdAt, updatedAt.",
|
||||
"",
|
||||
`Call this before \`${T.getResume}\`, \`${T.patchResume}\`, prompts, or \`resources/read\` with \`resume://{id}\`.`,
|
||||
"Results can be filtered by tags and sorted by last updated date, creation date, or name.",
|
||||
].join("\n"),
|
||||
inputSchema: z.object({
|
||||
tags: z
|
||||
.array(z.string())
|
||||
.optional()
|
||||
.default([])
|
||||
.describe("Filter resumes by tags. Only resumes matching ALL specified tags are returned. Default: no filter."),
|
||||
sort: z
|
||||
.enum(["lastUpdatedAt", "createdAt", "name"])
|
||||
.optional()
|
||||
.default("lastUpdatedAt")
|
||||
.describe("Sort order for results. Default: lastUpdatedAt."),
|
||||
}),
|
||||
annotations: TOOL_ANNOTATIONS[T.listResumes],
|
||||
},
|
||||
[T.listResumeTags]: {
|
||||
title: "List Resume Tags",
|
||||
description: [
|
||||
"Returns a sorted list of every distinct tag used across your resumes.",
|
||||
"Useful for choosing tag filters when calling list tools or keeping naming consistent.",
|
||||
].join("\n"),
|
||||
inputSchema: z.object({}),
|
||||
annotations: TOOL_ANNOTATIONS[T.listResumeTags],
|
||||
},
|
||||
[T.getResume]: {
|
||||
title: "Read Resume",
|
||||
description: [
|
||||
"Get the full data of a specific resume by its ID.",
|
||||
"",
|
||||
"Returns the complete resume data as JSON, including: basics (name, headline, email, phone,",
|
||||
"location, website), summary, picture settings, all sections (experience, education, skills,",
|
||||
"projects, etc.), custom sections, and metadata (template, layout, typography, colors).",
|
||||
"",
|
||||
`Use \`${T.listResumes}\` first to find valid IDs.`,
|
||||
"The `resume://_meta/schema` resource describes the full data structure for JSON Patch paths.",
|
||||
].join("\n"),
|
||||
inputSchema: z.object({ id: resumeIdSchema }),
|
||||
annotations: TOOL_ANNOTATIONS[T.getResume],
|
||||
},
|
||||
[T.getResumeAnalysis]: {
|
||||
title: "Get Resume Analysis",
|
||||
description: [
|
||||
"Returns the latest saved AI analysis for a resume (scorecard, strengths, suggestions), if any.",
|
||||
"Analyses are created from the Reactive Resume web app AI flow, not from MCP.",
|
||||
`Returns JSON or a short message if none exists. Use \`${T.listResumes}\` to find resume IDs.`,
|
||||
].join("\n"),
|
||||
inputSchema: z.object({ id: resumeIdSchema }),
|
||||
annotations: TOOL_ANNOTATIONS[T.getResumeAnalysis],
|
||||
},
|
||||
[T.downloadResumePdf]: {
|
||||
title: "Download Resume PDF",
|
||||
description: [
|
||||
"Create a short-lived authenticated URL for downloading a resume as a PDF.",
|
||||
"The URL expires in 10 minutes and should be used immediately.",
|
||||
"Returns JSON containing: resumeId, name, downloadUrl, expiresAt, expiresInSeconds, contentType.",
|
||||
`Use \`${T.listResumes}\` first to find valid IDs.`,
|
||||
].join("\n"),
|
||||
inputSchema: z.object({ id: resumeIdSchema }),
|
||||
annotations: TOOL_ANNOTATIONS[T.downloadResumePdf],
|
||||
},
|
||||
[T.createResume]: {
|
||||
title: "Create Resume",
|
||||
description: [
|
||||
"Create a new, empty resume with a name and URL-friendly slug.",
|
||||
"",
|
||||
"Returns the ID of the newly created resume.",
|
||||
"Set `withSampleData` to true to pre-fill with example content (useful for testing).",
|
||||
`After creating, use \`${T.getResume}\` to view or \`${T.patchResume}\` to populate it.`,
|
||||
].join("\n"),
|
||||
inputSchema: z.object({
|
||||
name: z.string().min(1).max(64).describe("Display name for the resume (e.g. 'Software Engineer 2026')"),
|
||||
slug: z
|
||||
.string()
|
||||
.min(1)
|
||||
.max(64)
|
||||
.describe("URL-friendly slug, must be unique across your resumes (e.g. 'software-engineer-2026')"),
|
||||
tags: z
|
||||
.array(z.string())
|
||||
.optional()
|
||||
.default([])
|
||||
.describe("Tags to categorize the resume (e.g. ['tech', 'senior'])"),
|
||||
withSampleData: z.boolean().optional().default(false).describe("Pre-fill with sample data. Default: false."),
|
||||
}),
|
||||
annotations: TOOL_ANNOTATIONS[T.createResume],
|
||||
},
|
||||
[T.importResume]: {
|
||||
title: "Import Resume",
|
||||
description: [
|
||||
"Create a new resume from a full ResumeData JSON object (e.g. an exported file from Reactive Resume).",
|
||||
"A random name and slug are assigned automatically, like the web importer.",
|
||||
`For small edits to an existing resume, prefer \`${T.patchResume}\` instead of re-importing.`,
|
||||
"Large payloads may exceed MCP client message limits — in that case, use the web UI or the HTTP API.",
|
||||
].join("\n"),
|
||||
inputSchema: z.object({
|
||||
data: z
|
||||
.unknown()
|
||||
.describe("Complete ResumeData JSON (same shape as `read_resume` body or `resume://_meta/schema`)."),
|
||||
}),
|
||||
annotations: TOOL_ANNOTATIONS[T.importResume],
|
||||
},
|
||||
[T.duplicateResume]: {
|
||||
title: "Duplicate Resume",
|
||||
description: [
|
||||
"Create a copy of an existing resume with all its data.",
|
||||
"",
|
||||
"Returns the ID of the newly duplicated resume.",
|
||||
"You must provide a new name and slug for the copy.",
|
||||
"Useful for creating job-specific variants of a base resume.",
|
||||
].join("\n"),
|
||||
inputSchema: z.object({
|
||||
id: resumeIdSchema.describe("ID of the resume to duplicate"),
|
||||
name: z.string().min(1).max(64).describe("Name for the duplicate"),
|
||||
slug: z.string().min(1).max(64).describe("URL-friendly slug for the duplicate (must be unique)"),
|
||||
tags: z.array(z.string()).optional().default([]).describe("Tags for the duplicate"),
|
||||
}),
|
||||
annotations: TOOL_ANNOTATIONS[T.duplicateResume],
|
||||
},
|
||||
[T.patchResume]: {
|
||||
title: "Apply Resume Patch",
|
||||
description: [
|
||||
"Apply JSON Patch (RFC 6902) operations to partially update a resume's data.",
|
||||
"",
|
||||
`This is the primary way to edit resume content. Use \`${T.getResume}\` first to inspect the`,
|
||||
"current structure, and `resume://_meta/schema` to understand valid paths and types.",
|
||||
"",
|
||||
"Supported operations: add, remove, replace, move, copy, test.",
|
||||
"",
|
||||
"Common path examples:",
|
||||
" /basics/name — Change the name",
|
||||
" /basics/headline — Change the headline",
|
||||
" /summary/content — Replace summary (HTML string)",
|
||||
" /sections/experience/items/- — Append a new experience item",
|
||||
" /sections/experience/items/0/company — Update first experience's company",
|
||||
" /sections/skills/items/- — Append a new skill",
|
||||
" /metadata/template — Change the template (e.g. 'azurill', 'bronzor', 'onyx')",
|
||||
" /metadata/design/colors/primary — Change the primary color (rgba string)",
|
||||
" /sections/interests/hidden — Hide/show a section",
|
||||
"",
|
||||
"Important: HTML content fields (description, summary.content) must use valid HTML.",
|
||||
"New items must include a valid UUID as `id` and `hidden: false`.",
|
||||
`Locked resumes cannot be patched — use \`${T.unlockResume}\` first.`,
|
||||
].join("\n"),
|
||||
inputSchema: z.object({
|
||||
id: resumeIdSchema,
|
||||
operations: resumePatchOperationsSchema,
|
||||
}),
|
||||
annotations: TOOL_ANNOTATIONS[T.patchResume],
|
||||
},
|
||||
[T.updateResume]: {
|
||||
title: "Update Resume (metadata)",
|
||||
description: [
|
||||
"Update resume metadata only: display name, URL slug, tags, and/or public visibility.",
|
||||
"Does not change section content — use JSON Patch via the patch tool for body edits.",
|
||||
`Locked resumes cannot be updated; use \`${T.unlockResume}\` first.`,
|
||||
"Password protection cannot be set or removed via MCP; use the web app for that.",
|
||||
"",
|
||||
"Always returns your canonical share URL (`{app}/{username}/{slug}`). Anonymous viewers can use it only when `isPublic` is true; password protection from the web app still applies.",
|
||||
].join("\n"),
|
||||
inputSchema: z.object({
|
||||
id: resumeIdSchema,
|
||||
name: z.string().min(1).max(64).optional().describe("Display name for the resume."),
|
||||
slug: z.string().min(1).max(64).optional().describe("URL-friendly slug; must stay unique among your resumes."),
|
||||
tags: z.array(z.string()).optional().describe("Replace the resume's tags (omit to leave unchanged)."),
|
||||
isPublic: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe(
|
||||
"When true, anyone with the link can view the public resume (subject to password if set in the app).",
|
||||
),
|
||||
}),
|
||||
annotations: TOOL_ANNOTATIONS[T.updateResume],
|
||||
},
|
||||
[T.deleteResume]: {
|
||||
title: "Delete Resume",
|
||||
description: [
|
||||
"Permanently delete a resume and all its associated files (screenshots, PDFs).",
|
||||
"",
|
||||
`This action is IRREVERSIBLE. Locked resumes cannot be deleted — use \`${T.unlockResume}\` first.`,
|
||||
`Consider using \`${T.duplicateResume}\` to create a backup before deleting.`,
|
||||
].join("\n"),
|
||||
inputSchema: z.object({ id: resumeIdSchema }),
|
||||
annotations: TOOL_ANNOTATIONS[T.deleteResume],
|
||||
},
|
||||
[T.lockResume]: {
|
||||
title: "Lock Resume",
|
||||
description: [
|
||||
"Lock a resume to prevent any modifications.",
|
||||
"",
|
||||
`When locked, a resume cannot be edited (${T.patchResume}, ${T.updateResume}), or deleted.`,
|
||||
"Useful for protecting finalized resumes from accidental changes.",
|
||||
`Use \`${T.unlockResume}\` to re-enable editing.`,
|
||||
].join("\n"),
|
||||
inputSchema: z.object({ id: resumeIdSchema }),
|
||||
annotations: TOOL_ANNOTATIONS[T.lockResume],
|
||||
},
|
||||
[T.unlockResume]: {
|
||||
title: "Unlock Resume",
|
||||
description: "Unlock a previously locked resume, re-enabling edits, patches, and deletion.",
|
||||
inputSchema: z.object({ id: resumeIdSchema }),
|
||||
annotations: TOOL_ANNOTATIONS[T.unlockResume],
|
||||
},
|
||||
[T.getResumeStatistics]: {
|
||||
title: "Get Resume Statistics",
|
||||
description: [
|
||||
"Get view and download statistics for a resume.",
|
||||
"",
|
||||
"Returns: isPublic (boolean), views (count), downloads (count),",
|
||||
"lastViewedAt (timestamp or null), lastDownloadedAt (timestamp or null).",
|
||||
].join("\n"),
|
||||
inputSchema: z.object({ id: resumeIdSchema }),
|
||||
annotations: TOOL_ANNOTATIONS[T.getResumeStatistics],
|
||||
},
|
||||
} as const;
|
||||
Reference in New Issue
Block a user