prompt-design

Create xmcp Prompt

You are helping the user create a new xmcp prompt. Follow this interactive workflow.

Step 1: Gather Information

Before generating any code, ask the user these questions using AskUserQuestion:

1. Prompt name (if not provided): What should the prompt be named? (Use kebab-case)

2. Prompt type: Ask which type of prompt they need:

   • Simple - Static prompt text without parameters
   • Parameterized - Prompt with user-provided parameters (most common)
   • Multi-content - Returns multiple content blocks (text, images, etc.)

3. Parameters (if parameterized): What inputs should the prompt accept?

   • Parameter name
   • Type (string, number, enum)
   • Description
   • Whether it's optional
   • Any validation or default values

4. Role: What role should the prompt assume?

   • user - Prompt from user perspective (most common)
   • assistant - Prompt as assistant response template

5. Use case: What is the prompt designed for?

   • Code review
   • Documentation generation
   • Data analysis
   • Content creation
   • Other specific task

Step 2: Generate the Prompt

Create the prompt file in src/prompts/:

File Location

src/prompts/{prompt-name}.ts

Prompt Structure Reference

Every xmcp prompt has three main exports:

// 1. Schema (optional) - Define parameters with Zod
export const schema = { /* ... */ };

// 2. Metadata (optional) - Prompt configuration
export const metadata: PromptMetadata = { /* ... */ };

// 3. Handler (required) - Default export function
export default function handler(params?) { /* ... */ }

Quick Reference

Essential Imports

import { type PromptMetadata } from "xmcp";

// For parameterized prompts
import { z } from "zod";
import { type InferSchema, type PromptMetadata } from "xmcp";

Metadata Fields

Field	Type	Required	Description
name	string	No*	Unique prompt identifier
title	string	No	Human-readable title
description	string	No	What this prompt does
role	string	No	"user" or "assistant" (default: user)