xmcp Application

This project was created with create-xmcp-app.

Getting Started

First, run the development server:

1
npm run dev
2
# or
3
yarn dev
4
# or
5
pnpm dev

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

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:

1
import { z } from 'zod'
2
import { type InferSchema } from 'xmcp'
3

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

10
// Define tool metadata
11
export const metadata = {
12
  name: 'add',
13
  description: 'Add two numbers together',
14
  annotations: {
15
    title: 'Add Two Numbers',
16
    readOnlyHint: true,
17
    destructiveHint: false,
18
    idempotentHint: true,
19
  },
20
}
21

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

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:

1
npm run build
2
# or
3
yarn build
4
# or
5
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:

1
npm run start
2
# or
3
yarn start
4
# or
5
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