Skip to content

Reference

The Reference section covers the surfaces you look up while writing code — exact API signatures, CLI flags, environment-variable names, and vendor-specific model-parameter cheatsheets. It is deliberately compact and lookup-shaped.

Use it alongside the other sections:

  • Concepts explains the architecture and the design rationale behind features like DDDI, tag matching, and the registry.
  • Tutorial walks you through building a real multi-agent application from scratch.
  • The Python SDK, Java SDK, and TypeScript SDK sections in the top nav are the language-specific deep references — decorators, annotations, per-language idioms.

Reference is what you reach for after you know the shape of the thing and just need the exact spelling.

Sections

  • API

    Symbol references for the multimodal media surfaces — return types, parameter annotations, upload helpers, and storage configuration.

  • CLI

    meshctl command reference — every subcommand, flag, and environment variable that the CLI honors, generated from the embedded man pages.

    meshctl Overview

  • Environment Variables

    Exhaustive list of runtime environment variables read by the registry, agents, and SDKs — TLS, observability, retries, transport, and more.

    Environment Variables

  • Kwargs

    Vendor-specific model_params cheatsheet for @mesh.llm consumers — thinking_config (Gemini), output_config (Anthropic), reasoning_effort (OpenAI), and the cross-vendor common kwargs.

    LLM Kwargs

See also

  • Python SDK — decorators, dependency injection, LLM integration, FastAPI wiring.
  • Java SDK — Spring Boot annotations and integration.
  • TypeScript SDK — mesh functions and Express wiring.
  • Concepts — architecture and design rationale.
  • Tutorial — guided build of a multi-agent application.