Project on Go Micro

Contributing

Mon, 01 Jan 0001 00:00:00 +0000

This is a rendered copy of the repository CONTRIBUTING.md for convenient access via the documentation site.

Overview

Go Micro welcomes contributions of all kinds: code, documentation, examples, and plugins.

Quick Start

git clone --depth 1 https://github.com/micro/go-micro.git
cd go-micro
go mod download
go test ./...

Process

Fork and create a feature branch
Make focused changes with tests
Run linting and full test suite
Open a PR describing motivation and approach

Commit Format

Use conventional commits:

Roadmap

Mon, 01 Jan 0001 00:00:00 +0000

Go Micro is a framework for building agents and services in Go. An agent is a distributed system — it discovers services, calls them, holds state, and recovers from failure — so building an agent is building a service. The roadmap has two jobs: make agentic development excellent, and make the developer experience around it excellent. Nothing else.

Where we are (v6)

The foundation is in place:

Services — register, discover, RPC, events; every endpoint is automatically an MCP tool.
Agents — a model with memory and tools that manages services, with plan, delegate, and guardrails (MaxSteps, LoopLimit, ApproveTool) built in, plus tool-execution middleware (WrapTool) and run metadata.
Flows — durable, event-driven workflows: ordered steps that checkpoint and resume after a crash.
Interop — the MCP gateway (services as tools) and the A2A gateway (agents as agents, both directions, including A2A streaming, push notifications, and multi-turn continuation), both generated from the registry; x402 for paid tools.
Secure by default — TLS verification on, state scoped per component.

Principles

These constrain everything below:

Powered by Go Micro Badge

Mon, 01 Jan 0001 00:00:00 +0000

Markdown Badges

Dark Badge

[![Powered by Go Micro](https://img.shields.io/badge/Powered%20by-Go%20Micro-0366d6?style=for-the-badge&logo=go&logoColor=white)](https://go-micro.dev)

Light Badge

[![Powered by Go Micro](https://img.shields.io/badge/Powered%20by-Go%20Micro-00ADD8?style=flat&logo=go&logoColor=white)](https://go-micro.dev)

Compact Badge

[![Go Micro](https://img.shields.io/badge/Go-Micro-0366d6?style=flat-square)](https://go-micro.dev)

HTML Badges

Standard HTML Badge

<a href="https://go-micro.dev" target="_blank">
 <img src="https://img.shields.io/badge/Powered%20by-Go%20Micro-0366d6?style=for-the-badge&logo=go&logoColor=white" alt="Powered by Go Micro">
</a>

Custom SVG Badge

<a href="https://go-micro.dev" style="display:inline-block;text-decoration:none;">
 <svg width="160" height="32" xmlns="http://www.w3.org/2000/svg">
 <rect width="160" height="32" rx="6" fill="#0366d6"/>
 <text x="16" y="21" font-family="system-ui,-apple-system,sans-serif" font-size="13" font-weight="600" fill="white">
 Powered by Go Micro
 </text>
 </svg>
</a>

Usage

Add one of these badges to your README.md, documentation, or website footer to show that your project uses Go Micro.

Server (optional)

Mon, 01 Jan 0001 00:00:00 +0000

Micro Server (Optional)

The Micro server is an optional web dashboard and authenticated API gateway for production environments. It provides a secure entrypoint for discovering and interacting with services that are already running (e.g., managed by systemd via micro deploy).

micro server does not build, run, or watch services. It only discovers services via the registry and provides a UI/API to interact with them.

micro server vs micro run

	`micro run`	`micro server`
Purpose	Local development	Production dashboard
Builds services	Yes	No
Runs services	Yes (as child processes)	No (discovers already-running services)
Hot reload	Yes	No
Authentication	Yes (default `admin`/`micro`)	Yes (default `admin`/`micro`)
Scopes	Yes (`/auth/scopes`)	Yes (`/auth/scopes`)
Dashboard	Full gateway UI with auth, scopes, agent	Full dashboard with API explorer, logs, user/token management
When to use	Day-to-day development	Deployed environments, shared servers

For local development, use micro run instead.