MCP Typescript Server Starter

🚀 MCP TypeScript Project Guide

MCP (possibly referring to "Multi-Chat Protocol" or other specific abbreviations) is a TypeScript-based server framework for building and managing complex chat or communication systems. This guide details how to use this framework to implement a fully functional server.

🚀 Quick Start

Initialize the Project

1. Create a new project

   mkdir my-mcp-server && cd my-mcp-server
   

2. Install dependencies

   npm init -y
   npm install mcp-server typescript --save-dev
   

3. Configure TypeScript Add the following content to tsconfig.json:

   {
     "compilerOptions": {
       "target": "ES2020",
       "module": "CommonJS",
       "outDir": "./dist",
       "rootDir": "./src",
       "strict": true,
       "esModuleInterop": true,
       "skipLibCheck": true
     }
   }
   

4. Write the main file Add the following content to src/index.ts:

   import { MCPServer } from 'mcp-server';
   
   const server = new MCPServer({
     port: 3001,
     hostname: 'localhost',
   });
   
   // Register tools, resources, and prompts (see below)
   server.start();
   

5. Run the project

   npm run dev
   

✨ Features

Tool Definition

In src/index.ts, you can register a simple echo tool as follows:

server.tool("echo", { message: z.string() }, async ({ message }) => ({
  content: [{ type: "text", text: `Tool echo: ${message}` }],
}));

Resource Definition

You can use the following code to implement URI-based resource access:

server.resource(
  "echo",
  new ResourceTemplate("echo://{message}", { list: undefined }),
  async (uri, { message }) => ({
    contents: [
      {
        uri: uri.href,
        text: `Resource echo: ${message}`,
      },
    ],
  })
);

Prompt Definition

In src/index.ts, you can register a prompt template:

server.prompt("echo", { message: z.string() }, ({ message }) => ({
  messages: [
    {
      role: "user",
      content: {
        type: "text",
        text: `Please process this message: ${message}`,
      },
    },
  ],
}));

📚 Documentation

Server Configuration

Endpoints and Interfaces

• Default Port: 3001
• Default Hostname: localhost
• Listening Address: 0.0.0.0 (allows external access)

Logging and Debugging

Enable logging as follows:

server.configure({
  logging: {
    enabled: true,
    level: 'debug',
  },
});

Deployment and Expansion

Deploy with Docker

1. Create a Dockerfile

   FROM node:16
   
   WORKDIR /app
   
   COPY package.json ./
   RUN npm install
   
   COPY src/ ./src/
   
   EXPOSE 3001
   
   CMD ["npm", "run", "start"]
   

2. Build the image

   docker build -t mcp-server .
   

3. Run the container

   docker run -p 3001:3001 --name mcp-server mcp-server
   

Environment Variables

Configure Environment Variables

In src/index.ts, you can read environment variables as follows:

const port = process.env.PORT || 3001;

Example Configuration File

Create a .env file:

PORT=3001
NODE_ENV=development

Debug Information

Output Debug Logs

In src/index.ts, you can add the following code to output debug information:

server.on('debug', (message) => {
  console.log(`Debug: ${message}`);
});

Catch Errors

Catch and handle errors as follows:

server.on('error', (error) => {
  console.error(`Error: ${error.message}`);
});

Best Practices

Code Structure

• Modularity: Split functionality into multiple files, such as tools/, resources/, and prompts/.
• Dependency Management: Use package.json to manage all dependencies.
• Version Control: Use git for version control.

Performance Optimization

1. Caching

   const cache = new Map();
   

2. Asynchronous Operations

   async function handleRequest() {
     await someAsyncFunction();
   }
   

📄 License

This project is licensed under the MIT License. The specific content is as follows:

Copyright (c) 2023 Your Name/Company Name. This software is distributed in source code form. Anyone can use, copy, modify, and distribute it freely, but must comply with the following conditions:

• The copyright notice and license notice must be retained in the distributed derivative works.

📚 Appendix

Frequently Asked Questions

1. How to change the port?

   server.configure({
     port: 3002,
   });
   

2. How to disable logging?

   server.configure({
     logging: {
       enabled: false,
     },
   });
   

Contribution Guide

Contributions are welcome! Please fork this repository and submit your changes in the gh-pages branch.

By following the above steps, you can easily get started with the MCP TypeScript project and expand and optimize its functionality according to your needs.