internal/website/content/en/docs/guides/micro-run.md
micro run provides a complete development environment for Go microservices.
Note: This guide focuses on
micro runfeatures. For a comparison withmicro serverand gateway architecture details, see the CLI & Gateway Guide.
micro runis a development tool. It builds and supervises your service processes locally with hot reload. There is no daemon — everything stops whenmicro runexits. For running services in production, see Going to production.
micro new helloworld
cd helloworld
micro run
Open http://localhost:8080 to see your service.
When you run micro run, you get:
| URL | Description |
|---|---|
| http://localhost:8080 | Web dashboard - browse and call services |
| http://localhost:8080/agent | Agent playground - AI chat with MCP tools |
| http://localhost:8080/api | API explorer - browse endpoints and schemas |
| http://localhost:8080/api/{service}/{method} | API gateway - HTTP to RPC proxy |
| http://localhost:8080/mcp/tools | MCP tools - list all services as AI tools |
| http://localhost:8080/auth/tokens | Token management - create and manage API tokens |
| http://localhost:8080/auth/scopes | Scope management - restrict endpoint access |
| http://localhost:8080/auth/users | User management - create and manage users |
| http://localhost:8080/health | Health checks - aggregated service health |
| http://localhost:8080/services | Service list - JSON |
Plus:
--mcp-addressThe gateway converts HTTP requests to RPC calls. On loopback (the micro run default) no auth is needed — just call it:
curl -X POST http://localhost:8080/api/helloworld/Say.Hello \
-d '{"name": "World"}'
# Response
{"message": "Hello World"}
See Authentication for when a token is required.
Auth follows the socket, not the command. The bind address decides the default:
127.0.0.1/localhost, the micro run default) → auth off. You're already behind the OS boundary, so there's no login to call your own tools.0.0.0.0 or a routable IP) → auth on automatically. The instant it's reachable by others it's protected.When auth is on there is no default credential. A machine token is printed once at startup (or supply your own with --auth-token / MICRO_AUTH_TOKEN), and every /api and /mcp call carries it:
curl -H "Authorization: Bearer <token>" http://HOST:8080/api/helloworld/Say.Hello -d '{"name":"World"}'
# SSE / browser links can use ?token=<token> instead
Override the default either way with --auth / --no-auth (or MICRO_AUTH=on|off).
Capability-aware, even locally: a tool that declares a required scope — actions, paid tools — always needs a token bearing that scope, even on a loopback gateway with auth off. Read-only tools stay open; dangerous ones don't. Manage per-endpoint scopes at /auth/scopes.
The agent playground at /agent lets you interact with your services using AI. Your services are automatically exposed as MCP (Model Context Protocol) tools — no configuration needed.
The MCP tools API is available at:
/mcp/tools — list all services as AI-callable tools/mcp/call — invoke a tool (service endpoint) by nameFor a dedicated MCP protocol listener (for external AI clients), use:
micro run --mcp-address :3000
By default, micro run watches for .go file changes and automatically rebuilds and restarts affected services.
micro run # Hot reload enabled (default)
micro run --no-watch # Disable hot reload
Changes are debounced (300ms) to handle rapid saves from editors.
For multi-service projects, create a micro.mu file to define services, dependencies, and environments.
# Service definitions
service users
path ./users
port 8081
service posts
path ./posts
port 8082
depends users
service web
path ./web
port 8089
depends users posts
# Environment configurations
env development
STORE_ADDRESS file://./data
DEBUG true
env production
STORE_ADDRESS postgres://localhost/db
DEBUG false
{
"services": {
"users": {
"path": "./users",
"port": 8081
},
"posts": {
"path": "./posts",
"port": 8082,
"depends": ["users"]
}
},
"env": {
"development": {
"STORE_ADDRESS": "file://./data"
}
}
}
| Property | Required | Description |
|---|---|---|
path | Yes | Directory containing the service (with main.go) |
port | No | Port the service listens on (enables health check waiting) |
depends | No | Services that must start first (space-separated in .mu, array in .json) |
When depends is specified, services start in topological order:
port, we wait for /health to return 200micro run # Uses 'development' (default)
micro run --env production # Uses 'production'
micro run --env staging # Uses 'staging'
MICRO_ENV=test micro run # Environment variable override
Environment variables from the config are injected into each service's environment.
On SIGINT (Ctrl+C) or SIGTERM:
If no micro.mu or micro.json exists:
main.go files are discovered recursivelyEvery service streams to the terminal running micro run, colorized and
prefixed with the service name. The same output is also written to a file:
tail -f ~/micro/logs/users-*.log # one file per service: {service}-{hash}.log
micro run is itself the process manager for as long as it runs — there is no
daemon and no micro status/micro stop command. Stop everything with
Ctrl-C; services are shut down in reverse dependency order.
On a .go change a service is rebuilt in place. If the rebuild fails to
compile, the previous version keeps running and the build error is printed —
a typo never takes your service offline. New service directories added while
micro run is up (e.g. by micro new or micro chat) are picked up and started
automatically.
A multi-service app is described with a micro.mu file:
# micro.mu
service users
path ./users
port 8081
service posts
path ./posts
port 8082
depends users
service comments
path ./comments
port 8083
depends users posts
service web
path ./web
port 8089
depends users posts comments
Run it — from the local directory, or straight from a repo:
micro run . # current directory
micro run github.com/myorg/blog # remote repo
micro run # Gateway on :8080, hot reload
micro run --address :3000 # Custom gateway port
micro run --no-gateway # Services only, no HTTP gateway
micro run --no-watch # Disable hot reload
micro run --env production # Use production environment
micro run --mcp-address :3000 # Enable MCP protocol gateway for AI clients
micro run has no production mode by design — it's the dev inner loop. In
development it also hands you a gateway for free (--no-gateway to skip); in
production you don't run micro run at all. To ship:
go build produces a static binary.port for services to enable health check waiting/health returning 200 for reliable startup sequencing.go files trigger rebuilds; static assets don't