Boilerplate MCP Server

🚀 Template MCP Server

The Template MCP Server is a baseline implementation for quickly launching and running Model Context Protocol (MCP) projects. It offers developers a standardized infrastructure to easily build, customize, and publish their own custom MCP servers.

🚀 Quick Start

Project Structure

.
├── package.json          # Package management file
├── src/
│   ├── index.ts         # Entry point
│   └── tools/           # Directory for MCP tool definitions
│       └── example.tool.ts # Example tool implementation
├── cli/                 # Command-line interface directory
│   └── example.cli.ts   # Example CLI command
└── types/               # Type definition folder
    └── common.types.ts  # Common type definitions

Running the Server

# Development mode
npm run dev

# Production mode
npm start

# Logs with debugging
DEBUG=true npm run dev

Configuration Options

{
    "boilerplate": {
        "environments": {
            "development": {
                "port": 3000,
                "host": "localhost"
            },
            "production": {
                "port": 80,
                "host": "your-domain.com"
            }
        },
        "logging": {
            "level": "debug",
            "disabled": false
        }
    }
}

Debugging Tools

MCP Inspector

1. Run the server: npm run dev
2. Open your browser and visit: http://localhost:5173
3. Test your tools in the console and view detailed request/response information

Publishing Guide

When you're ready to publish your custom MCP server:

1. Update the details in the package.json file.
2. Update the README.md file to include documentation for your tools.
3. Build the project: npm run build
4. Test the production build: npm run start:server
5. Publish to the npm repository: npm publish

📄 License

ISC License

{
    "boilerplate": {
        "environments": {
            "DEBUG": "true",
            "ANY_OTHER_CONFIG": "value"
        }
    }
}

⚠️ Important Note

To maintain backward compatibility, the server can also recognize configurations under @aashari/boilerplate-mcp-server or the unscoped package name boilerplate-mcp-server if the boilerplate key is not found. However, it is recommended to use the short boilerplate key to define new configurations.