Yokai MCP Server Template

> MCP server template based on the Yokai Go framework.

<!-- TOC -->
Documentation
Overview
Layout
Makefile
Getting started
Installation
With GitHub
With gonew
* Usage
<!-- TOC -->

Documentation

For more information about the Yokai framework, you can check its documentation.

Overview

This template provides:

- a ready to extend Yokai application, with the MCP server module installed
- a ready to use dev environment, based on Air (for live reloading)
- a ready to use Dockerfile for production
- some examples of MCP tool and test to get started

Layout

This template is following the recommended project layout:

- cmd/: entry points
- configs/: configuration files
- internal/:
- tool/: MCP tool and test examples
- bootstrap.go: bootstrap
- register.go: dependencies registration

Makefile

This template provides a Makefile:

make up      # start the docker compose stack
make down    # stop the docker compose stack
make logs    # stream the docker compose stack logs
make fresh   # refresh the docker compose stack
make test    # run tests
make lint    # run linter

Getting started

Installation

With GitHub

You can create your repository using the GitHub template.

It will automatically rename your project resources and push them, this operation can take a few minutes.

Once ready, after cloning and going into your repository, simply run:

make fresh

With gonew

You can install gonew, and simply run:

gonew github.com/ankorstore/yokai-mcp-template github.com/foo/bar
cd bar
make fresh

Usage

Once ready, the application will be available on:

- http://localhost:8080/sse for the application MCP server
- http://localhost:8081 for the application core dashboard