Litemcp

🚀 LiteMCP English Documentation

A TypeScript framework for elegantly building MCP (Model Context Protocol) servers

⚠️ Important Note

Since the official SDK already provides high-level APIs similar to this project, this project will no longer be maintained.

If you like the CLI commands in this project, use them independently: https://github.com/wong2/mcp-cli

✨ Features

• Simple definition of tools, resources, and prompts
• Full TypeScript support
• Built-in logging
• Built-in error handling
• Built-in CLI for testing and debugging
• Built-in support for SSE transport

📦 Installation

npm install litemcp zod

🚀 Quick Start

import { LiteMCP } from "litemcp";
import { z } from "zod";

const server = new LiteMCP("demo", "1.0.0");

server.addTool({
  name: "add",
  description: "Add two numbers",
  parameters: z.object({
    a: z.number(),
    b: z.number(),
  }),
  execute: async (args) => {
    return args.a + args.b;
  },
});

server.addResource({
  name: "resource-example",
  description: "This is an example resource",
  content: "Hello, World!",
});

server.start();

Run the following command to test the server:

node server.js

📚 Documentation

Core Concepts

Tools

Tools are functions that define executable operations. For example, a simple calculator tool.

server.addTool({
  name: "calculator",
  description: "A simple calculator",
  parameters: z.object({
    a: z.number(),
    b: z.number(),
  }),
  async execute(args) {
    return { 
      add: args.a + args.b,
      subtract: args.a - args.b
    };
  },
});

Resources

Resources represent static or dynamically generated content that can be accessed.

server.addResource({
  name: "static-resource",
  description: "A static resource example",
  content: "This is a static resource.",
});

server.addDynamicResource(async () => {
  return {
    name: "dynamic-resource",
    description: "A dynamic resource example",
    content: await fetch('https://api.example.com/data'),
  };
});

Prompts

Prompts are used to define interactive dialogue flows.

server.addPrompt({
  name: "greeting-prompt",
  description: "A simple greeting prompt",
  async execute() {
    const name = await server.prompt("Please enter your name:");
    return `Hello, ${name}!`;
  },
});

Logging

LiteMCP provides built-in logging functionality.

server.log("Info log");
server.debug("Debug log");
server.error("Error log");

Running Your Server

Starting the Server

By default, the server uses stdio transport:

server.start();

You can also specify a custom port and other options:

server.start({
  port: 3000,
  hostname: 'localhost',
});

Debugging and Logging

You can debug through the following command:

node server.js --inspect

Meanwhile, LiteMCP provides built-in debugging functionality:

server.debug("Debug information");

SSE Transport

The server runs stdio transport by default. You can also use SSE mode:

server.start({
  transportType: "sse",
  sse: {
    endpoint: "/sse",
    port: 8080,
  },
});

This will start the server and listen for SSE connections at http://localhost:8080/sse.

💻 Showcase

If you've developed a server using LiteMCP, showcase it here by submitting a PR!

• https://github.com/wong2/mcp-jina-reader
• https://github.com/nloui/paperless-mcp

📈 Roadmap

• Add support for resource templates

📚 Related Projects

• mcp-cli - A CLI for testing and debugging MCP servers
• mcpservers.org - A curated list of MCP servers
• FastMCP - A Python library for MCP server development, the inspiration for this project