Documentation

LLM-optimized documentation for Goa and Goa-AI frameworks. Consolidated pages designed for easy copying into LLM contexts.

Documentation Sections

This documentation is organized into consolidated, self-contained pages optimized for LLM consumption. Each page can be copied in full to provide comprehensive context.

Goa Framework

Design-first API development with automatic code generation for Go microservices.

Guide	Description	~Tokens
Quickstart	Install Goa and build your first service	~1,100
DSL Reference	Complete reference for Goa’s design language	~2,900
Code Generation	Understanding Goa’s code generation process	~2,100
HTTP Guide	HTTP transport features, routing, and patterns	~1,700
gRPC Guide	gRPC transport features and streaming	~1,800
Error Handling	Defining and handling errors	~1,800
Interceptors	Interceptors and middleware patterns	~1,400
Production	Observability, security, and deployment	~1,300

Total Goa Section: ~14,500 tokens

Goa-AI Framework

Design-first framework for building agentic, tool-driven systems in Go.

Guide	Description	~Tokens
Quickstart	Installation and first agent	~2,700
DSL Reference	Complete DSL: agents, toolsets, policies, MCP	~3,600
Runtime	Runtime architecture, plan/execute loop, engines	~2,400
Toolsets	Toolset types, execution models, transforms	~2,300
Agent Composition	Agent-as-tool, run trees, streaming topology	~1,400
MCP Integration	MCP servers, transports, generated wrappers	~1,200
Memory & Sessions	Transcripts, memory stores, sessions, runs	~1,600
Production	Temporal setup, streaming UI, model integration	~2,200

Total Goa-AI Section: ~17,600 tokens

Using This Documentation with LLMs

Copy Page Feature

Every documentation page includes a “Copy page” button with two options:

Copy as Markdown — Preserves formatting, code block language annotations, and heading hierarchy
Copy as Plain Text — Clean text without markdown syntax, suitable for any context

Recommended Workflow

Start with the Quickstart — Copy the quickstart guide to give your LLM basic context
Add specific guides — Copy relevant guides based on your task (e.g., HTTP Guide for REST APIs)
Include DSL Reference — For design questions, include the complete DSL reference

Token Budget Tips

Each guide is designed to fit within typical LLM context windows
The complete Goa documentation (~14.5k tokens) fits easily in most modern LLMs
The complete Goa-AI documentation (~17.6k tokens) is similarly compact
Both frameworks together (~32k tokens) work well with larger context models

Key Concepts

Design-First Development

Both Goa and Goa-AI follow a design-first philosophy:

Define your API/Agent using a powerful DSL
Generate code automatically from your design
Implement business logic in clean, type-safe interfaces
Documentation stays in sync because it comes from the same source

Type Safety

Generated code provides end-to-end type safety:

// Generated interface - your contract
type Service interface {
    Add(context.Context, *AddPayload) (int, error)
}

// Your implementation - clean and focused
func (s *service) Add(ctx context.Context, p *calc.AddPayload) (int, error) {
    return p.A + p.B, nil
}

Community

Gophers Slack — #goa channel
GitHub Discussions — Questions and ideas
Bluesky — Updates and announcements

Contributing

Want to improve the documentation? See the Contributing Guide for guidelines on canonical homes, cross-linking patterns, and content strategy.

In This Section

Goa Framework

Design-first API development with automatic code generation for Go microservices.

LLM Ready Complete Goa Documentation

Goa-AI Framework

Design-first framework for building agentic, tool-driven systems in Go.

LLM Ready Complete Goa-AI Documentation

Ecosystem & Tools

Companion libraries that extend Goa: architecture diagrams, distributed events, and observability.

LLM Ready Goa Ecosystem Overview

Contributing to Documentation

Guidelines for contributing to Goa documentation: canonical homes, cross-linking, and content strategy.

LLM Ready Documentation Contribution Guide