Dart MCP Server Template

🚀 Dart MCP Server Template

A template for creating Dart service applications compatible with MCP (Model Control Protocol). This template provides a starting point, including Docker configuration, server implementation, and a basic project structure.

🚀 Quick Start

Cloning the Repository and Updating Package Names

Clone this repository and manually update the package name:

git clone https://github.com/jhgaylor/dart-mcp-server-template.git my_new_mcp_server
cd my_new_mcp_server

# Update the package name in the codebase
find . -type f -name "*.dart" -o -name "pubspec.yaml" | xargs sed -i 's/dart_mcp_server_template/my_new_mcp_server/g'
# Update the package name in the repository URL
find . -type f -name "*.md" -o -name "Dockerfile" | xargs sed -i 's/dart-mcp-server-template/my-new-mcp-server/g'
# Rename files
find . -type f -name "*dart_mcp_server_template*" | while read file; do mv "$file" "${file//dart_mcp_server_template/my_new_mcp_server}"; done

# Remove the old .git directory to start fresh
rm -rf .git

# Initialize a new Git repository
git init

Starting Development

After creating a project from the template:

1. Update the project details in pubspec.yaml.
2. Modify the configuration in lib/src/config.dart as needed.
3. Implement custom server logic.
4. Run the server using the provided entry points:
   • dart bin/stdio_server.dart (Standard I/O)
   • dart bin/sse_server.dart (Server-Sent Events)
   • dart bin/streamable_http_server.dart (HTTP Streaming)

✨ Features

Server Implementation

• bin/ - Contains executable Dart files for starting the server via different transport methods:

  • dart bin/stdio_server.dart: Start the server using standard I/O transport.
  • dart bin/sse_server.dart: Start the server using Server-Sent Events transport.
  • dart bin/streamable_http_server.dart: Start the server using HTTP streaming.
  • All these executables use the core server implementation defined in lib/src/server.dart.

• lib/src/server.dart - Sets up the basic MCP server. This is where most of your custom code will be written.

In-Memory Stream Transport

You can use IOStreamTransport to fully connect Dart clients and servers in memory. Here is an end-to-end example.

Template Content

This template includes:

• An executable Dart server implementation using standard I/O, Server-Sent Events, and HTTP streaming.
• Docker configuration for easy deployment.
• A basic project structure, including lib, bin, and test directories.
• Integration with the mcp_dart package.

📦 Installation

Docker Deployment

This template includes a Dockerfile for easy containerization:

# Build the Docker image
docker build -t my-mcp-server .

# Run the container
docker run -p 3000:3000 my-mcp-server

📄 License

This template is released under the MIT License. When you generate your own application from this template, you are free to choose the license for your project; the template does not enforce a specific license on your generated code.