@epic-web/workshop-mcp 6.54.0 → 6.54.2

package/dist/index.js

@@ -5,6 +5,7 @@ import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'
 import * as Sentry from '@sentry/node';
 import { initPrompts } from "./prompts.js";
 import { initResources } from "./resources.js";
+import { serverInstructions } from "./server-metadata.js";
 import { initPromptTools, initResourceTools, initTools } from "./tools.js";
 // Get environment variables
 const env = getEnv();
@@ -27,16 +28,7 @@ const server = new McpServer({
 }, 
 // TODO: add some common workflows to the instructions
 {
-    instructions: `
-This is intended to be used within a workshop using the Epic Workshop App
-(@epic-web/workshop-app) to help learners in the process of completing the
-workshop exercises and understanding the learning outcomes.
-
-The user's work in progress is in the \`playground\` directory. Any changes they
-ask you to make should be in this directory.
-
-Most of the time you should use the \`get_what_is_next\` tool to get the next step the user needs to complete.
-		`.trim(),
+    instructions: serverInstructions,
 });
 // Wrap with Sentry if enabled
 const monitoredServer = env.EPICSHOP_IS_PUBLISHED && env.SENTRY_DSN

package/dist/prompts.js

@@ -2,13 +2,14 @@ import { getExercises } from '@epic-web/workshop-utils/apps.server';
 import { getWorkshopConfig } from '@epic-web/workshop-utils/config.server';
 import { z } from 'zod';
 import { exerciseContextResource } from "./resources.js";
+import { formatPromptDescription, promptDocs } from "./server-metadata.js";
 import { handleWorkshopDirectory, workshopDirectoryInputSchema, } from "./utils.js";
 export const quizMeInputSchema = {
     workshopDirectory: workshopDirectoryInputSchema,
     exerciseNumber: z
         .string()
         .optional()
-        .describe(`The exercise number to get quizzed on (e.g., \`4\`). Leave blank for a random exercise.`),
+        .describe('Exercise number to quiz on (e.g., "4"). Omit for a random exercise.'),
 };
 export async function quizMe({ workshopDirectory, exerciseNumber: providedExerciseNumber, }) {
     const workshopRoot = await handleWorkshopDirectory(workshopDirectory);
@@ -49,8 +50,8 @@ Please use this context to provide quiz questions, one at a time, to me to help
 }
 export function initPrompts(server) {
     server.registerPrompt('quiz_me', {
-        title: 'Quiz Me',
-        description: 'Have the LLM quiz you on topics from the workshop exercises',
+        title: promptDocs.quiz_me.title,
+        description: formatPromptDescription(promptDocs.quiz_me),
         argsSchema: quizMeInputSchema,
     }, quizMe);
 }

package/dist/resources.js

@@ -5,6 +5,7 @@ import { getAuthInfo } from '@epic-web/workshop-utils/db.server';
 import { getEpicVideoInfos, userHasAccessToWorkshop, getUserInfo, getProgress, } from '@epic-web/workshop-utils/epic-api.server';
 import { ResourceTemplate, } from '@modelcontextprotocol/sdk/server/mcp.js';
 import { z } from 'zod';
+import { resourceDocs } from "./server-metadata.js";
 import { handleWorkshopDirectory, readInWorkshop, safeReadFile, workshopDirectoryInputSchema, } from "./utils.js";
 export const getWorkshopContextInputSchema = {
     workshopDirectory: workshopDirectoryInputSchema,
@@ -82,8 +83,8 @@ export async function getWorkshopContextResource({ workshopDirectory, }) {
     };
 }
 export const workshopContextResource = {
-    name: 'workshop_context',
-    description: 'The context of the workshop',
+    name: resourceDocs.workshop_context.name,
+    description: resourceDocs.workshop_context.description,
     uriTemplate: workshopContextUriTemplate,
     getResource: getWorkshopContextResource,
     inputSchema: getWorkshopContextInputSchema,
@@ -93,7 +94,7 @@ const getExerciseContextInputSchema = {
     exerciseNumber: z.coerce
         .number()
         .optional()
-        .describe(`The exercise number to get the context for (defaults to the exercise number the playground is currently set to)`),
+        .describe(`Exercise number to fetch (defaults to the current playground exercise if omitted).`),
 };
 async function getExerciseContext({ workshopDirectory, exerciseNumber, }) {
     const { userHasAccess, authInfo, progress, numbers } = await getCommonContextData(workshopDirectory);
@@ -189,8 +190,8 @@ async function getExerciseContextResource({ workshopDirectory, exerciseNumber, }
     };
 }
 export const exerciseContextResource = {
-    name: 'exercise_context',
-    description: 'The context of the exercise',
+    name: resourceDocs.exercise_context.name,
+    description: resourceDocs.exercise_context.description,
     uriTemplate: exerciseContextUriTemplate,
     getResource: getExerciseContextResource,
     inputSchema: getExerciseContextInputSchema,
@@ -274,10 +275,10 @@ const getExerciseStepContextInputSchema = {
     workshopDirectory: workshopDirectoryInputSchema,
     exerciseNumber: z.coerce
         .number()
-        .describe('The exercise number to get the context for'),
+        .describe('Exercise number to fetch (1-based).'),
     stepNumber: z.coerce
         .number()
-        .describe('The step number to get the context for'),
+        .describe('Step number to fetch within the exercise (1-based).'),
 };
 async function getExerciseStepContext({ workshopDirectory, exerciseNumber, stepNumber, }) {
     const { userHasAccess, authInfo, progress, numbers } = await getCommonContextData(workshopDirectory);
@@ -354,16 +355,20 @@ async function getExerciseStepContextResource({ workshopDirectory, exerciseNumbe
     };
 }
 export const exerciseStepContextResource = {
-    name: 'exercise_step_context',
-    description: 'The context of a specific exercise step',
+    name: resourceDocs.exercise_step_context.name,
+    description: resourceDocs.exercise_step_context.description,
     uriTemplate: exerciseStepContextUriTemplate,
     getResource: getExerciseStepContextResource,
     inputSchema: getExerciseStepContextInputSchema,
 };
 const diffBetweenAppsInputSchema = {
     workshopDirectory: workshopDirectoryInputSchema,
-    app1: z.string().describe('The ID of the first app'),
-    app2: z.string().describe('The ID of the second app'),
+    app1: z
+        .string()
+        .describe('First app ID (format: "02.03.problem" or "02.03.solution").'),
+    app2: z
+        .string()
+        .describe('Second app ID (format: "02.03.problem" or "02.03.solution").'),
 };
 async function getDiffBetweenApps({ workshopDirectory, app1, app2, }) {
     await handleWorkshopDirectory(workshopDirectory);
@@ -401,8 +406,8 @@ async function getDiffBetweenAppsResource({ workshopDirectory, app1, app2, }) {
 }
 const diffBetweenAppsUriTemplate = new ResourceTemplate('epicshop://{workshopDirectory}/diff-between-apps/{app1}__vs___{app2}', { list: undefined });
 export const diffBetweenAppsResource = {
-    name: 'diff_between_apps',
-    description: 'The diff between two apps',
+    name: resourceDocs.diff_between_apps.name,
+    description: resourceDocs.diff_between_apps.description,
     uriTemplate: diffBetweenAppsUriTemplate,
     getResource: getDiffBetweenAppsResource,
     inputSchema: diffBetweenAppsInputSchema,
@@ -438,8 +443,8 @@ async function getExerciseStepProgressDiffResource({ workshopDirectory, }) {
     };
 }
 export const exerciseStepProgressDiffResource = {
-    name: 'exercise_step_progress_diff',
-    description: 'The diff between the current exercise step and the solution',
+    name: resourceDocs.exercise_step_progress_diff.name,
+    description: resourceDocs.exercise_step_progress_diff.description,
     uriTemplate: exerciseStepProgressDiffUriTemplate,
     getResource: getExerciseStepProgressDiffResource,
     inputSchema: getExerciseStepProgressDiffInputSchema,
@@ -459,8 +464,8 @@ async function getUserInfoResource({ workshopDirectory, }) {
     };
 }
 export const userInfoResource = {
-    name: 'user_info',
-    description: 'Information about the current user',
+    name: resourceDocs.user_info.name,
+    description: resourceDocs.user_info.description,
     uriTemplate: userInfoUri,
     getResource: getUserInfoResource,
     inputSchema: getUserInfoInputSchema,
@@ -480,8 +485,8 @@ async function getUserAccessResource({ workshopDirectory, }) {
     };
 }
 export const userAccessResource = {
-    name: 'user_access',
-    description: 'Whether the current user has access to the workshop',
+    name: resourceDocs.user_access.name,
+    description: resourceDocs.user_access.description,
     uriTemplate: userAccessUriTemplate,
     getResource: getUserAccessResource,
     inputSchema: getUserAccessInputSchema,
@@ -501,8 +506,8 @@ async function getUserProgressResource({ workshopDirectory, }) {
     };
 }
 export const userProgressResource = {
-    name: 'user_progress',
-    description: 'The progress of the current user',
+    name: resourceDocs.user_progress.name,
+    description: resourceDocs.user_progress.description,
     uriTemplate: userProgressUriTemplate,
     getResource: getUserProgressResource,
     inputSchema: userProgressInputSchema,

package/dist/server-metadata.d.ts

@@ -0,0 +1,476 @@
+export type ToolAnnotationHints = {
+    readOnlyHint: boolean;
+    destructiveHint: boolean;
+    idempotentHint: boolean;
+    openWorldHint: boolean;
+};
+type ToolInputDoc = {
+    name: string;
+    type: string;
+    required: boolean;
+    description: string;
+    examples?: Array<string>;
+};
+type ToolExampleDoc = {
+    description: string;
+    params: string;
+};
+export type ToolDoc = {
+    title: string;
+    summary: string;
+    inputs: Array<ToolInputDoc>;
+    returns: string;
+    examples: Array<ToolExampleDoc>;
+    nextSteps: Array<string>;
+    errorNextSteps?: Array<string>;
+    annotations: ToolAnnotationHints;
+};
+type PromptDoc = {
+    title: string;
+    description: string;
+    examples: Array<string>;
+    nextSteps: Array<string>;
+};
+export declare const serverInstructions: string;
+export declare const toolDocs: {
+    login: {
+        title: string;
+        summary: string;
+        inputs: {
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        }[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        errorNextSteps: string[];
+        annotations: {
+            readOnlyHint: false;
+            destructiveHint: false;
+            idempotentHint: false;
+            openWorldHint: true;
+        };
+    };
+    logout: {
+        title: string;
+        summary: string;
+        inputs: {
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        }[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        annotations: {
+            readOnlyHint: false;
+            destructiveHint: false;
+            idempotentHint: false;
+            openWorldHint: false;
+        };
+    };
+    set_playground: {
+        title: string;
+        summary: string;
+        inputs: ({
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        } | {
+            name: string;
+            type: string;
+            required: false;
+            description: string;
+            examples: string[];
+        })[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        errorNextSteps: string[];
+        annotations: {
+            readOnlyHint: false;
+            destructiveHint: false;
+            idempotentHint: false;
+            openWorldHint: false;
+        };
+    };
+    update_progress: {
+        title: string;
+        summary: string;
+        inputs: ({
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        } | {
+            name: string;
+            type: string;
+            required: false;
+            description: string;
+            examples: string[];
+        })[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        errorNextSteps: string[];
+        annotations: {
+            readOnlyHint: false;
+            destructiveHint: false;
+            idempotentHint: false;
+            openWorldHint: true;
+        };
+    };
+    get_workshop_context: {
+        title: string;
+        summary: string;
+        inputs: {
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        }[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        annotations: {
+            readOnlyHint: true;
+            destructiveHint: false;
+            idempotentHint: true;
+            openWorldHint: true;
+        };
+    };
+    get_exercise_context: {
+        title: string;
+        summary: string;
+        inputs: ({
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        } | {
+            name: string;
+            type: string;
+            required: false;
+            description: string;
+            examples: string[];
+        })[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        annotations: {
+            readOnlyHint: true;
+            destructiveHint: false;
+            idempotentHint: true;
+            openWorldHint: true;
+        };
+    };
+    get_diff_between_apps: {
+        title: string;
+        summary: string;
+        inputs: {
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        }[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        annotations: {
+            readOnlyHint: true;
+            destructiveHint: false;
+            idempotentHint: true;
+            openWorldHint: false;
+        };
+    };
+    get_exercise_step_progress_diff: {
+        title: string;
+        summary: string;
+        inputs: {
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        }[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        annotations: {
+            readOnlyHint: true;
+            destructiveHint: false;
+            idempotentHint: true;
+            openWorldHint: false;
+        };
+    };
+    get_exercise_step_context: {
+        title: string;
+        summary: string;
+        inputs: {
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        }[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        annotations: {
+            readOnlyHint: true;
+            destructiveHint: false;
+            idempotentHint: true;
+            openWorldHint: true;
+        };
+    };
+    view_video: {
+        title: string;
+        summary: string;
+        inputs: {
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        }[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        annotations: {
+            readOnlyHint: true;
+            destructiveHint: false;
+            idempotentHint: true;
+            openWorldHint: true;
+        };
+    };
+    open_exercise_step_files: {
+        title: string;
+        summary: string;
+        inputs: {
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        }[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        annotations: {
+            readOnlyHint: false;
+            destructiveHint: false;
+            idempotentHint: false;
+            openWorldHint: false;
+        };
+    };
+    get_user_info: {
+        title: string;
+        summary: string;
+        inputs: {
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        }[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        annotations: {
+            readOnlyHint: true;
+            destructiveHint: false;
+            idempotentHint: true;
+            openWorldHint: true;
+        };
+    };
+    get_user_access: {
+        title: string;
+        summary: string;
+        inputs: {
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        }[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        annotations: {
+            readOnlyHint: true;
+            destructiveHint: false;
+            idempotentHint: true;
+            openWorldHint: true;
+        };
+    };
+    get_user_progress: {
+        title: string;
+        summary: string;
+        inputs: {
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        }[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        annotations: {
+            readOnlyHint: true;
+            destructiveHint: false;
+            idempotentHint: true;
+            openWorldHint: true;
+        };
+    };
+    get_quiz_instructions: {
+        title: string;
+        summary: string;
+        inputs: ({
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        } | {
+            name: string;
+            type: string;
+            required: false;
+            description: string;
+            examples: string[];
+        })[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        annotations: {
+            readOnlyHint: true;
+            destructiveHint: false;
+            idempotentHint: true;
+            openWorldHint: false;
+        };
+    };
+    get_what_is_next: {
+        title: string;
+        summary: string;
+        inputs: {
+            name: string;
+            type: string;
+            required: true;
+            description: string;
+            examples: string[];
+        }[];
+        returns: string;
+        examples: {
+            description: string;
+            params: string;
+        }[];
+        nextSteps: string[];
+        annotations: {
+            readOnlyHint: true;
+            destructiveHint: false;
+            idempotentHint: false;
+            openWorldHint: true;
+        };
+    };
+};
+export declare const promptDocs: {
+    quiz_me: {
+        title: string;
+        description: string;
+        examples: string[];
+        nextSteps: string[];
+    };
+};
+export declare const resourceDocs: {
+    workshop_context: {
+        name: string;
+        description: string;
+    };
+    exercise_context: {
+        name: string;
+        description: string;
+    };
+    exercise_step_context: {
+        name: string;
+        description: string;
+    };
+    diff_between_apps: {
+        name: string;
+        description: string;
+    };
+    exercise_step_progress_diff: {
+        name: string;
+        description: string;
+    };
+    user_info: {
+        name: string;
+        description: string;
+    };
+    user_access: {
+        name: string;
+        description: string;
+    };
+    user_progress: {
+        name: string;
+        description: string;
+    };
+};
+export declare function formatToolDescription(doc: ToolDoc): string;
+export declare function formatPromptDescription(doc: PromptDoc): string;
+export {};