# Gortexa

> A contract-first gRPC framework for Go. One h2c port serves gRPC, HTTP/JSON and MCP, sharing one interceptor chain, one error model and one auth path.

## Documentation sets

- [Complete documentation](https://gortexa.sheng.page/llms-full.txt): every page as one file
- [Abridged documentation](https://gortexa.sheng.page/llms-small.txt): a compact subset for smaller context windows

## Docs

- [Gortexa](https://gortexa.sheng.page/en/): A contract-first Go gRPC framework. One h2c port serves gRPC, HTTP/JSON and MCP.
- [Quickstart with AI](https://gortexa.sheng.page/en/ai-quickstart/): Use a reproducible prompt to build and verify a Gortexa prototype, then plan a production foundation.
- [Quickstart](https://gortexa.sheng.page/en/quickstart/): Install a pinned toolchain and CLI, create a project, generate your first API, and verify HTTP and MCP.
- [Core concepts](https://gortexa.sheng.page/en/concepts/): The contract-first flow, single h2c port multiplexing, the fixed-order interceptor chain and the unified error model.
- [gRPC](https://gortexa.sheng.page/en/transports/grpc/): Native gRPC over cleartext HTTP/2, health mapping and the reflection switch.
- [HTTP/JSON](https://gortexa.sheng.page/en/transports/http-json/): The grpc-gateway REST surface, route mapping, CORS and OpenAPI.
- [MCP](https://gortexa.sheng.page/en/transports/mcp/): The /mcp endpoint exposes annotated proto methods as AI tools; calls run through the full interceptor chain.
- [Components](https://gortexa.sheng.page/en/components/): After go get, the purpose, import path and a minimal example for every public package.
- [Core](https://gortexa.sheng.page/en/components/core/): kernel, config, interceptor, auth, apperr — assembly, config, the interceptor chain, JWT and the error model.
- [HTTP & MCP](https://gortexa.sheng.page/en/components/http-mcp/): httpcompat, mcp — the grpc-gateway HTTP/JSON layer and the MCP bridge.
- [Batteries](https://gortexa.sheng.page/en/components/batteries/): mq, cache, storage, client — messaging, caching, the database pool and outbound clients.
- [Observability & health](https://gortexa.sheng.page/en/components/observability/): health, observability — three-state health and OTLP logs/traces/metrics.
- [Configuration](https://gortexa.sheng.page/en/configuration/): config.yaml sections, layered loading with environment overrides, switching the cache backend, and the secret rules.
- [Deployment](https://gortexa.sheng.page/en/deployment/): TLS termination, wiring readiness to real dependencies, the authn/authz boundary, and graceful shutdown.
- [Examples overview](https://gortexa.sheng.page/en/examples/): Gortexa's verification matrix — 11 runnable scenarios, each proving one framework behaviour.
- [Developer flow](https://gortexa.sheng.page/en/examples/workflow/): The scaffold loop and one entity exercised end to end across three protocols.
- [Security & boundaries](https://gortexa.sheng.page/en/examples/security/): Auth rejections leak nothing, secret startup safety, the header allowlist, the reflection gate.
- [Contract & resilience](https://gortexa.sheng.page/en/examples/resilience/): The buf breaking gate blocks breaking changes; graceful drain on SIGTERM.
- [AI & messaging](https://gortexa.sheng.page/en/examples/messaging/): Export tool schemas; integration tests against real NATS and JetStream brokers.
- [Full example: assembling a service as a module](https://gortexa.sheng.page/en/examples/full-example/): After go get, wire the public packages into one complete, annotated main.go.