Skip to content

Commit a34214d

Browse files
Dumbrisclaude
andcommitted
chore(oas): regenerate OpenAPI artifacts for instructions field + document config
The new top-level config.Config.Instructions field is surfaced in the OpenAPI spec via GetConfigResponse, so the generated oas/swagger.yaml and oas/docs.go must be regenerated (make swagger) and committed — this is what the "Verify OpenAPI Artifacts" CI gate enforces. Also documents the `instructions` field in docs/configuration.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 7317d59 commit a34214d

3 files changed

Lines changed: 22 additions & 1 deletion

File tree

docs/configuration.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -649,6 +649,22 @@ All three modes are always available on dedicated endpoints regardless of config
649649

650650
See [Routing Modes](features/routing-modes.md) for complete details.
651651

652+
## Server Instructions
653+
654+
Text returned in the MCP `initialize` response to guide AI agents on how to use the proxy (e.g., use `retrieve_tools` to discover existing tools rather than `search_servers`).
655+
656+
```json
657+
{
658+
"instructions": "Use retrieve_tools to discover tools before assuming a capability is unavailable."
659+
}
660+
```
661+
662+
| Field | Type | Default | Description |
663+
|-------|------|---------|-------------|
664+
| `instructions` | string | _(built-in)_ | Custom instructions sent in the MCP `initialize` response. When empty, a built-in default explains the `retrieve_tools``call_tool_*` workflow and warns against using `search_servers` for existing tools. |
665+
666+
**Note:** Applied at startup / on the next client connect — editing this value does not hot-reload into already-connected MCP sessions.
667+
652668
---
653669

654670
## Tool-Level Quarantine

oas/docs.go

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

oas/swagger.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,11 @@ components:
6262
$ref: '#/components/schemas/secureenv.EnvConfig'
6363
features:
6464
$ref: '#/components/schemas/config.FeatureFlags'
65+
instructions:
66+
description: |-
67+
Instructions text returned in the MCP initialize response to guide AI agents.
68+
When empty, a built-in default is used that explains retrieve_tools workflow.
69+
type: string
6570
intent_declaration:
6671
$ref: '#/components/schemas/config.IntentDeclarationConfig'
6772
listen:

0 commit comments

Comments
 (0)