MCP Server Starter Typescript

🚀 MCP Server TypeScript Starter Template

This is a TypeScript starter template for creating a Model Context Protocol (MCP) server. It offers a basic setup and a sample tool implementation to help you quickly start building your own MCP server.

✨ Features

• TypeScript configuration
• Basic MCP server setup
• Sample tool implementation
• Type-safe development environment

🚀 Quick Start

Follow these steps to create your MCP server:

# Create the project directory
mkdir <project_name>
cd <project_name>

# Initialize a new npm project
npm init -y

# Install dependencies
npm install @modelcontextprotocol/sdk zod
npm install -D @types/node typescript

# Create the source code directory and the main file
mkdir src
touch src/index.ts

📁 Project Structure

.
├── src/
│   └── index.ts    # Main server implementation
├── package.json    # Project dependencies and scripts
└── tsconfig.json   # TypeScript configuration

💻 Development

1. Implement your tool in src/index.ts.
2. Build the project:

   npm run build
   

💻 Usage Examples

Basic Usage

To add a new tool, use the server.tool() method. Example:

server.tool(
  "tool-name",
  "tool-description",
  { 
    // Define your tool parameters using a Zod schema
    param: z.string().describe("parameter description") 
  },
  async ({ param }) => {
    // Implement your tool logic here
    return {
      content: [
        {
          type: "text",
          text: `The tool has been used with parameter: ${param}`,
        },
      ],
    };
  },
);

📚 Documentation

MCP Server Configuration

You can configure multiple MCP servers in your project. Here is an example configuration:

{
    "mcpServers": {
        "<server_name>": {
            "command": "<command>",
            "args": [
                "--directory",
                "/ABSOLUTE/PATH/TO/PARENT/FOLDER/<project_name>",
                "run",
                "<script_name>"
            ]
        }
    }
}

This configuration specifies:

• <server_name>: A unique identifier for the MCP server.
• command: The command to run the script (e.g., python, node, uv).
• args: An array of command-line arguments.
  • --directory: Sets the working directory for the script.
  • Other specific parameters for your command and script requirements.

You can add more server configurations by simply adding more entries to the mcpServers object.

📄 License

ISC