Getting started - MCP application
Yokai provides a ready to use MCP server application template to start your MCP projects.
Overview
The MCP server application 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 pointsconfigs/
: configuration filesinternal/
:tool/
: MCP tool and test examplesbootstrap.go
: bootstrapregister.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
Installation
With GitHub
You can create your repository using the GitHub template.
It will automatically rename your project resources, this operation can take a few minutes.
Once ready, after cloning and going into your repository, simply run:
With gonew
You can install gonew, and simply run:
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
Going further
To go further, you can:
- check the MCP server module documentation to learn more about its features
- follow the MCP application tutorial to create, step by step, an MCP server application
- test the MCP demo application to see all this in action