# oryn

> A modular Go framework built on fx, OpenTelemetry native, documented for humans and agents.

- oryn is a Go framework: applications are assembled from modules (core, httpserver, httpclient, grpcserver, grpcclient, mcpserver, mcpclient, sql, validator, worker, cron) with uber/fx dependency injection.
- A complete example application, serving one domain module over HTTP, gRPC and MCP: https://github.com/go-oryn/demo
- Extension points are `AsXxx` helpers (e.g. `httpserver.AsHandler`, `health.AsProbe`) taking values or fx constructors.
- Every module is instrumented with OpenTelemetry; standard `OTEL_*` environment variables win over the `otel.*` config keys.
- Tests run applications with `coretest.Start` and assert telemetry in memory with the `oteltest` packages.
- Go API reference: https://pkg.go.dev/github.com/go-oryn/oryn

## Documentation Sets

- [Abridged documentation](https://go-oryn.github.io/oryn/llms-small.txt): a compact version of the documentation for oryn, with non-essential content removed
- [Complete documentation](https://go-oryn.github.io/oryn/llms-full.txt): the full documentation for oryn
- [Start here](https://go-oryn.github.io/oryn/_llms-txt/start-here.txt): overview, getting started guide, and the rules for agents writing oryn code
- [Demo](https://go-oryn.github.io/oryn/_llms-txt/demo.txt): the demo application: one tasks module served over HTTP, gRPC and MCP, entrypoints, telemetry and tests
- [Core](https://go-oryn.github.io/oryn/_llms-txt/core.txt): application, configuration, OpenTelemetry, logging, health checks and testing
- [HTTP server](https://go-oryn.github.io/oryn/_llms-txt/http-server.txt): the httpserver module: handlers, middlewares, handler groups, observability and testing
- [gRPC server](https://go-oryn.github.io/oryn/_llms-txt/grpc-server.txt): the grpcserver module: services, interceptors, health, reflection, observability and testing
- [MCP server](https://go-oryn.github.io/oryn/_llms-txt/mcp-server.txt): the mcpserver module: MCP tools, resources and prompts, streamable HTTP, observability and testing
- [HTTP client](https://go-oryn.github.io/oryn/_llms-txt/http-client.txt): the httpclient module: instrumented HTTP client, transport middlewares, configuration and in-memory testing
- [gRPC client](https://go-oryn.github.io/oryn/_llms-txt/grpc-client.txt): the grpcclient module: named gRPC connections, interceptors, configuration and in-memory testing
- [MCP client](https://go-oryn.github.io/oryn/_llms-txt/mcp-client.txt): the mcpclient module: sessions to MCP servers, configuration, observability and in-memory testing
- [Validator](https://go-oryn.github.io/oryn/_llms-txt/validator.txt): the validator module: struct validation, custom validations, observability and testing
- [Worker](https://go-oryn.github.io/oryn/_llms-txt/worker.txt): the worker module: background workers, restarts, health, observability and testing
- [Cron](https://go-oryn.github.io/oryn/_llms-txt/cron.txt): the cron module: scheduled jobs, schedules per environment, observability and testing
- [SQL](https://go-oryn.github.io/oryn/_llms-txt/sql.txt): the sql module: PostgreSQL, MySQL and SQLite connection pool, migrations, observability and testing

## Notes

- The complete documentation includes all content from the official documentation
- The content is automatically generated from the same source as the official documentation