MCP TypeScript 模板

Getting Started

The easiest way to get started is using degit:

1. Create a new project from this template

   npx degit nickytonline/mcp-typescript-template my-mcp-server
   cd my-mcp-server
   

1. Install dependencies

   npm install
   

1. Build the project

   npm run build
   

4. Start the server

   npm start
   

The server will be available at http://localhost:3000 for MCP connections.

Build the project

npm run build

Docker

Build and run using Docker:

• Build the Docker image

docker build -t my-mcp-server .

• Run the container

docker run -p 3000:3000 my-mcp-server

Docker Compose

```yaml

docker-compose.yml

version: "3.8" services: mcp-server: build: . ports: - "3000:3000" environment: - PORT=3000

Example: Adding a New Tool

import { createTextResult } from "./lib/utils.js";

server.registerTool(
  "my_tool",
  {
    title: "My Custom Tool",
    description: "Description of what this tool does",
    inputSchema: {
      param1: z.string().describe("Description of param1"),
      param2: z.number().optional().describe("Optional parameter"),
    },
  },
  async (args) => {
    // Your tool logic here
    const result = await myCustomLogic(args.param1, args.param2);

    return createTextResult(result);
  },
);

Repository Guidelines

Contributors should review AGENTS.md for project structure, coding standards, and pull request expectations before opening changes.

Alternative: Using GitHub Template

You can also click the "Use this template" button on GitHub to create a new repository, then clone it:

git clone <your-repo-url>
cd my-mcp-server
npm install