/examples

Go Micro Examples

This directory contains runnable examples demonstrating various go-micro features and patterns.

Quick Start

Each example can be run with go run . from its directory.

Examples

hello-world

Basic RPC service demonstrating core concepts:

• Service creation and registration
• Handler implementation
• Client calls
• Health checks

Run it:

cd hello-world
go run .

web-service

HTTP web service with service discovery:

• HTTP handlers
• Service registration
• Health checks
• JSON REST API

Run it:

cd web-service
go run .

multi-service

Multiple services in a single binary — the modular monolith pattern:

• Isolated server, client, store, and cache per service
• Shared registry and broker for inter-service communication
• Coordinated lifecycle with service.Group
• Start monolith, split later when you need to scale independently

Run it:

cd multi-service
go run .

deployment

Docker Compose deployment with MCP gateway, Consul registry, and Jaeger tracing:

• Production-like architecture in one docker-compose up
• Standalone MCP gateway connected to service registry
• Distributed tracing with OpenTelemetry + Jaeger

MCP Examples

See the mcp/ directory for AI agent integration examples:

• hello - Minimal MCP service (start here)
• crud - CRUD contact book with full agent documentation
• workflow - Cross-service orchestration via AI agents
• documented - All MCP features with auth scopes

agent-demo

Multi-service project management app (Projects, Tasks, Team) with seed data and agent playground integration.

pubsub-events

Event-driven architecture with two patterns:

• Broker — fire-and-forget messaging with queue groups
• Events — durable streaming with replay, ack/nack, and consumer groups
• Service integration with event publishing

Run it:

cd pubsub-events
go run .

grpc-integration

Using go-micro with gRPC transport:

• gRPC server with reflection-based registration (no protobuf required)
• gRPC client with retries and JSON codec
• Raw bytes codec for dynamic payloads
• Same handler code — just swap the transport

Run it:

cd grpc-integration
go run .

Prerequisites

Some examples require external dependencies:

• NATS: docker run -p 4222:4222 nats:latest
• Consul: docker run -p 8500:8500 consul:latest agent -dev -ui -client=0.0.0.0
• Redis: docker run -p 6379:6379 redis:latest

Contributing

To add a new example:

1. Create a new directory
2. Add a descriptive README.md
3. Include working code with comments
4. Add to this index
5. Ensure it runs with go run .