Skip to content

Commit d3a0bd9

Browse files
committed
docs: update AGENTS.md
1 parent 488ae7e commit d3a0bd9

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

AGENTS.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,30 @@ cargo doc --no-deps
3636
cargo llvm-cov --all-features --workspace --codecov --output-path codecov.json
3737
```
3838

39+
## Runtime Quick Reference
40+
41+
- Start with config file: `cargo run -p apollo-mcp-server -- path/to/config.yaml`
42+
- Start from env only: `cargo run -p apollo-mcp-server`
43+
- Config precedence: `APOLLO_MCP_*` env overrides YAML values.
44+
- Supported transports: `stdio` (default) and `streamable_http`; `sse` is not supported.
45+
- YAML env expansion supports `${env.VAR}` and `${env.VAR:-default}`.
46+
47+
### Common Config Keys
48+
49+
- Top-level keys: `endpoint`, `transport`, `operations`, `schema`, `introspection`, `graphos`, `overrides`, `headers`, `forward_headers`, `health_check`, `cors`, `telemetry`, `logging`, `server_info`, `custom_scalars`.
50+
- `auth` must be nested under `transport` (not top-level).
51+
- `operations.source`: `infer` (default), `local`, `manifest`, `collection`, `introspect`, `uplink`.
52+
- `schema.source`: `local` or `uplink`.
53+
54+
### Useful Env Vars
55+
56+
- GraphOS mapping:
57+
- `APOLLO_GRAPH_REF` -> `graphos.apollo_graph_ref`
58+
- `APOLLO_KEY` -> `graphos.apollo_key`
59+
- `APOLLO_UPLINK_ENDPOINTS` -> `graphos.apollo_uplink_endpoints`
60+
- Nested config override format: `APOLLO_MCP_<SECTION>__<NESTED_KEY>=...`
61+
- Example: `APOLLO_MCP_INTROSPECTION__EXECUTE__ENABLED=true`
62+
3963
## Workspace Structure
4064

4165
The project is a Rust workspace with three crates:

0 commit comments

Comments
 (0)