xmcp Application

This project was created with create-xmcp-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

This will start the MCP server with the selected transport method.

Related MCP server: template-mcp

Project Structure

This project uses the structured approach where tools are automatically discovered from the src/tools directory. Each tool is defined in its own file with the following structure:

import { z } from 'zod'
import { type InferSchema } from 'xmcp'

// Define the schema for tool parameters
export const schema = {
  a: z.number().describe('First number to add'),
  b: z.number().describe('Second number to add'),
}

// Define tool metadata
export const metadata = {
  name: 'add',
  description: 'Add two numbers together',
  annotations: {
    title: 'Add Two Numbers',
    readOnlyHint: true,
    destructiveHint: false,
    idempotentHint: true,
  },
}

// Tool implementation
export default async function add({ a, b }: InferSchema<typeof schema>) {
  return {
    content: [{ type: 'text', text: String(a + b) }],
  }
}

Adding New Tools

To add a new tool:

1. Create a new .ts file in the src/tools directory

2. Export a schema object defining the tool parameters using Zod

3. Export a metadata object with tool information

4. Export a default function that implements the tool logic

Building for Production

To build your project for production:

npm run build
# or
yarn build
# or
pnpm build

This will compile your TypeScript code and output it to the dist directory.

Running the Server

You can run the server for the transport built with:

• HTTP: node dist/http.js

• STDIO: node dist/stdio.js

Alternatively, you can use the script which will automatically start the appropriate transport based on your project configuration:

npm run start
# or
yarn start
# or
pnpm start

The start script will automatically run either the HTTP or STDIO transport depending on which transport method was selected when you initialized the project.

Learn More

• xmcp Documentation