Skip to content

Commit dc5674c

Browse files
committed
chore: Update readme
1 parent 9fa5db2 commit dc5674c

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,10 @@ Tests live under `tests/`:
138138

139139
## MCP Prompts
140140

141-
| Prompt | Arguments | Description |
142-
|--------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------|
143-
| `service_overview` | `service` | Walks the client through producing an architectural overview of a service: HTTP entry points, domain types, and notable framework conventions |
141+
| Prompt | Arguments | Description |
142+
|-------------------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------|
143+
| `service_overview` | `service` | Walks the client through producing an architectural overview of a service: HTTP entry points, domain types, and notable framework conventions |
144+
| `system_design_overview` | *(none)* | Walks the client through producing a complete system design overview: service inventory, communication topology, shared data stores, and cross-cutting concerns — includes Mermaid diagrams |
144145

145146
## HTTP API
146147

@@ -167,7 +168,7 @@ any context where observing indexing progress matters.
167168
| `EMBEDDINGS_PROVIDER` | `jina` | One of `jina`, `voyage`, `openai`, `ollama` — see *Embedding providers* below |
168169
| `GIT_HISTORY_MAX_COMMITS` | `500` | Max commits indexed per service |
169170
| `MCP_TRANSPORT` | `streamable-http` | One of `streamable-http`, `sse`, `stdio` |
170-
| `MCP_HOST` / `MCP_PORT` | `0.0.0.0` / `8090` | Server bind address |
171+
| `MCP_HOST` / `MCP_PORT` | `127.0.0.1` / `8090` | Server bind address |
171172
| `CONFIG_PATH` | `./config.yaml` | Path to the services config file |
172173

173174
## Embedding providers

0 commit comments

Comments
 (0)