GoAI

Appearance

Examples ​

Runnable examples demonstrating GoAI features. Each example is a standalone main.go that you can run directly.

All examples live in goai/examples/.

Core ​

Basic text generation, streaming, and structured output.

chat ​

Simple non-streaming text generation with GenerateText.

  • Provider: Google Gemini
  • Features: GenerateText, WithSystem, WithPrompt, token usage
  • Source: examples/chat/
bash
export GEMINI_API_KEY=...
go run examples/chat/main.go

streaming ​

Streaming text generation with real-time output via TextStream().

  • Provider: Google Gemini
  • Features: StreamText, TextStream(), Result() for usage after streaming
  • Source: examples/streaming/
bash
export GEMINI_API_KEY=...
go run examples/streaming/main.go

structured ​

Structured output with typed Go structs using GenerateObject[T] and StreamObject[T].

  • Provider: Google Gemini
  • Features: GenerateObject[T], StreamObject[T], PartialObjectStream(), SchemaFrom[T], struct tags (jsonschema)
  • Source: examples/structured/
bash
export GEMINI_API_KEY=...
go run ./examples/structured/main.go

embedding ​

Text embeddings with Embed and EmbedMany, including cosine similarity comparison.

  • Provider: Google Gemini (gemini-embedding-001)
  • Features: Embed, EmbedMany, auto-chunking, pairwise cosine similarity
  • Source: examples/embedding/
bash
export GEMINI_API_KEY=...
go run ./examples/embedding/main.go

citations ​

Accessing Sources from grounded AI responses. The Sources API is provider-agnostic.

  • Provider: Google Gemini
  • Features: TextResult.Sources, per-step sources, Source.URL, Source.Title, text offsets
  • Source: examples/citations/
bash
export GEMINI_API_KEY=...
go run examples/citations/main.go

Tools ​

Custom tools, agent loops, and provider-defined tools.

tools ​

Single-step tool call with a custom tool definition and Execute handler.

  • Provider: Google Gemini
  • Features: goai.Tool, InputSchema (JSON Schema), Execute function, WithMaxSteps(2)
  • Source: examples/tools/
bash
export GEMINI_API_KEY=...
go run examples/tools/main.go

agent-loop ​

Multi-step agent loop with multiple tools and step/tool-call callbacks.

  • Provider: Google Gemini
  • Features: Multiple tools, WithMaxSteps(5), WithOnStepFinish, WithOnToolCall, step history
  • Source: examples/agent-loop/
bash
export GEMINI_API_KEY=...
go run examples/agent-loop/main.go

Provider-Defined Tools ​

These examples use built-in tools provided by specific AI providers. The provider handles tool execution server-side.

Web search across OpenAI, Anthropic, and Google using their respective provider-defined tools.

  • Providers: OpenAI (direct + Azure), Anthropic (direct + Bedrock), Google
  • Features: openai.Tools.WebSearch(), anthropic.Tools.WebSearch(), google.Tools.GoogleSearch(), source citations
  • Source: examples/web-search/
bash
export OPENAI_API_KEY=...
go run examples/web-search/main.go openai

export ANTHROPIC_API_KEY=...
go run examples/web-search/main.go anthropic

export GEMINI_API_KEY=...
go run examples/web-search/main.go google

Google Search grounding with Gemini, returning grounded responses with source URLs.

bash
export GEMINI_API_KEY=...
go run examples/google-search/main.go

web-fetch ​

Anthropic's web fetch tool for retrieving and processing content from specific URLs.

  • Providers: Anthropic (direct + Bedrock)
  • Features: anthropic.Tools.WebFetch(), citation support, URL content processing
  • Source: examples/web-fetch/
bash
export ANTHROPIC_API_KEY=...
go run examples/web-fetch/main.go anthropic

computer-use ​

Anthropic's computer use tools: Computer (mouse/keyboard), Bash (shell), TextEditor (file editing).

  • Providers: Anthropic (direct + Bedrock)
  • Features: anthropic.Tools.Computer(), anthropic.Tools.Bash(), anthropic.Tools.TextEditor(), provider-defined tools with client-side Execute handlers
  • Source: examples/computer-use/
bash
export ANTHROPIC_API_KEY=...
go run examples/computer-use/main.go anthropic

code-execution ​

Anthropic's sandboxed Python code execution tool.

  • Providers: Anthropic (direct + Bedrock)
  • Features: anthropic.Tools.CodeExecution(), server-side Python execution (Anthropic direct) or tool-call-style client-side handling (Bedrock)
  • Source: examples/code-execution/
bash
export ANTHROPIC_API_KEY=...
go run examples/code-execution/main.go anthropic

code-interpreter ​

OpenAI's code interpreter tool for sandboxed Python execution.

  • Providers: OpenAI (direct + Azure)
  • Features: openai.Tools.CodeInterpreter(), server-side Python execution
  • Source: examples/code-interpreter/
bash
export OPENAI_API_KEY=...
go run examples/code-interpreter/main.go openai

google-code-execution ​

Google Gemini's sandboxed Python code execution tool.

bash
export GEMINI_API_KEY=...
go run examples/google-code-execution/main.go

image-generation ​

OpenAI's image generation tool via the Responses API. The LLM decides when to generate images during conversation.

  • Providers: OpenAI (direct + Azure)
  • Features: openai.Tools.ImageGeneration(), image quality/size options
  • Source: examples/image-generation/
bash
export OPENAI_API_KEY=...
go run examples/image-generation/main.go openai

OpenAI's file search tool for semantic/keyword search over vector stores.

  • Providers: OpenAI (direct + Azure)
  • Features: openai.Tools.FileSearch(), vector store integration
  • Source: examples/file-search/

Requires a pre-created vector store with uploaded files.

bash
export OPENAI_API_KEY=...
go run examples/file-search/main.go openai <vector-store-id>

MCP ​

MCP (Model Context Protocol) client examples. Connect to MCP servers and use their tools with GoAI.

mcp-tools ​

MCP tools with GoAI LLM integration. Connects to an MCP server, converts its tools, and passes them to GenerateText for an agent loop.

Note: This example requires a local MCP test server implementation compatible with the commands used in examples/mcp-tools/main.go.

  • Provider: Google Gemini
  • Features: mcp.NewStdioTransport, mcp.NewClient, mcp.ConvertTools, goai.WithTools, WithMaxSteps
  • Source: examples/mcp-tools/
bash
export GEMINI_API_KEY=...
go run ./examples/mcp-tools/main.go

mcp-filesystem ​

Filesystem MCP server integration via stdio. Lists available tools and calls list_directory on the official MCP filesystem server.

  • Transport: Stdio
  • Requires: Node.js (npx)
  • Features: mcp.NewStdioTransport, client.ListTools, tool calling, file operations
  • Source: examples/mcp-filesystem/
bash
go run ./examples/mcp-filesystem/main.go /tmp

mcp-github ​

GitHub MCP server integration via stdio. Discover and call GitHub tools.

  • Transport: Stdio
  • Requires: Node.js (npx), GITHUB_TOKEN
  • Features: mcp.NewStdioTransport, GitHub API tools
  • Source: examples/mcp-github/
bash
export GITHUB_TOKEN=ghp_...
go run ./examples/mcp-github/main.go

mcp-playwright ​

Playwright MCP server for browser automation. Navigate, click, fill, screenshot via MCP tools.

  • Transport: Stdio
  • Requires: Node.js (npx)
  • Features: mcp.NewStdioTransport, browser automation tools
  • Source: examples/mcp-playwright/
bash
go run ./examples/mcp-playwright/main.go

mcp-remote ​

MCP over Streamable HTTP transport. Demonstrates session management, notifications, and remote tool calling.

Note: This example requires a local MCP test server implementation compatible with the commands used in examples/mcp-remote/main.go.

  • Transport: Streamable HTTP
  • Features: mcp.NewHTTPTransport, session management, remote server
  • Source: examples/mcp-remote/
bash
go run ./examples/mcp-remote/main.go

mcp-sse ​

MCP over legacy SSE transport (protocol version 2024-11-05). Endpoint discovery, tool listing, and tool calling.

  • Transport: SSE (legacy)
  • Features: mcp.NewSSETransport, legacy protocol support
  • Source: examples/mcp-sse/
bash
go run ./examples/mcp-sse/main.go

mcp-local ​

MCP client basics without an LLM. Exercises every MCP capability: tools, prompts, and resources.

Note: This example requires a local MCP test server implementation compatible with the commands used in examples/mcp-local/main.go.

  • Transport: Stdio
  • Features: mcp.NewStdioTransport, client.ListTools, client.ListPrompts, client.ListResources
  • Source: examples/mcp-local/
bash
go run ./examples/mcp-local/main.go

Released under the MIT License.

Copyright © 2026 GoAI