Skip to content

Commit 3f0265e

Browse files
Add documentation
1 parent 8726da3 commit 3f0265e

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

docs/integration-guide.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ author: 'Your Name'
7777
# The fully qualified command to run the engine.
7878
# The platform executes this command directly — no implicit runtime setup.
7979
entrypoint: 'node --enable-source-maps dist/index.js'
80+
81+
# Optional: Specify the model vendor for model selection (e.g. 'Anthropic', 'OpenAI').
82+
# When set, the platform uses this to determine the available models for the engine.
83+
vendor: 'Anthropic'
8084
```
8185
8286
> **Note:** This is not a GitHub Action. The platform reads `entrypoint` from `engine.yaml` and runs it directly. All paths in the entrypoint are resolved relative to the engine's root directory.
@@ -97,7 +101,7 @@ The platform injects these environment variables into the engine process at runt
97101
| `GITHUB_SELECTED_MODEL` | No | Model selected by the platform for this run. Only set when model selection is enabled. |
98102
| `GITHUB_DEFAULT_MODEL` | No | Default model for the selected engine. Only set when model selection is enabled. |
99103
| `GITHUB_AVAILABLE_MODELS` | No | JSON array of models the engine can choose from (e.g. `["claude-sonnet-4.5","claude-opus-4.1"]`). Only set when model selection is enabled. |
100-
| `GITHUB_MODEL_VENDOR` | No | Model vendor for filtering (e.g. `Anthropic`, `OpenAI`). Only set when model selection is enabled. |
104+
| `GITHUB_MODEL_VENDOR` | No | Model vendor as defined by the `vendor` field in `engine.yaml` (e.g. `Anthropic`, `OpenAI`). Only set when model selection is enabled. |
101105

102106
## Step 2: Fetch Job Details
103107

@@ -172,7 +176,7 @@ Headers:
172176
| `selected_model` | Model selected by the platform for this run. Present when `features.model_selection` is `true`. |
173177
| `default_model` | Default model for the selected engine. Present when `features.model_selection` is `true`. |
174178
| `available_models` | List of models the engine can choose from. Present when `features.model_selection` is `true`. |
175-
| `model_vendor` | Model vendor for filtering (e.g. `Anthropic`, `OpenAI`). Present when `features.model_selection` is `true`. |
179+
| `model_vendor` | Model vendor as defined by the `vendor` field in `engine.yaml` (e.g. `Anthropic`, `OpenAI`). Present when `features.model_selection` is `true`. |
176180
| `mcp_proxy_url` | Optional URL of the MCP proxy server. When present, use it to discover user-provided MCP servers. See [User-Provided MCP Servers](#user-provided-mcp-servers). |
177181

178182
Use `GITHUB_INFERENCE_TOKEN` for model calls and `GITHUB_GIT_TOKEN` for git operations; those are bootstrap action inputs, not job response fields.

0 commit comments

Comments
 (0)