Skip to content

Commit 809cf2f

Browse files
committed
docs: clarify code SDK option contracts
1 parent afc429e commit 809cf2f

3 files changed

Lines changed: 24 additions & 8 deletions

File tree

sdk/node/generated.d.ts

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -409,7 +409,13 @@ export interface AutoDelegationOptions {
409409
export interface SessionOptions {
410410
/** Override the default model. Format: "provider/model" (e.g., "openai/gpt-4o"). */
411411
model?: string
412-
/** Enable built-in skills (4 skills: code-search, code-review, explain-code, find-bugs). */
412+
/**
413+
* Compatibility flag for the built-in skill registry.
414+
*
415+
* Built-ins are already present in the default effective registry; `true`
416+
* requests an explicit built-in registry, while `false` does not remove
417+
* default built-ins.
418+
*/
413419
builtinSkills?: boolean
414420
/** Extra directories to scan for skill files (.md with YAML frontmatter). */
415421
skillDirs?: Array<string>
@@ -1264,8 +1270,9 @@ export declare class Agent {
12641270
* @param dir - Path to the agent directory (prompt/skills/schedules/tools)
12651271
* @param workspace - Workspace directory each scheduled turn operates in
12661272
* @param options - Optional session overrides merged into every schedule session
1267-
* (model, llmClient, sessionStore, …); `promptSlots`/`sessionId` set here are
1268-
* NOT overridden so a host can pin them per schedule
1273+
* (model, llmClient, sessionStore, …). `promptSlots` is honored when
1274+
* provided; otherwise the AgentDir `instructions.md` slot is used.
1275+
* `sessionId` is always owned by the daemon and set to `schedule:<name>`.
12691276
*/
12701277
serveAgentDir(dir: string, workspace: string, options?: SessionOptions | undefined | null): Promise<ServeHandle>
12711278
}

sdk/node/src/lib.rs

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1779,7 +1779,11 @@ pub struct AutoDelegationOptions {
17791779
pub struct SessionOptions {
17801780
/// Override the default model. Format: "provider/model" (e.g., "openai/gpt-4o").
17811781
pub model: Option<String>,
1782-
/// Enable built-in skills (4 skills: code-search, code-review, explain-code, find-bugs).
1782+
/// Compatibility flag for the built-in skill registry.
1783+
///
1784+
/// Built-ins are already present in the default effective registry; `true`
1785+
/// requests an explicit built-in registry, while `false` does not remove
1786+
/// default built-ins.
17831787
pub builtin_skills: Option<bool>,
17841788
/// Extra directories to scan for skill files (.md with YAML frontmatter).
17851789
pub skill_dirs: Option<Vec<String>>,
@@ -3033,8 +3037,9 @@ impl Agent {
30333037
/// @param dir - Path to the agent directory (prompt/skills/schedules/tools)
30343038
/// @param workspace - Workspace directory each scheduled turn operates in
30353039
/// @param options - Optional session overrides merged into every schedule session
3036-
/// (model, llmClient, sessionStore, …); `promptSlots`/`sessionId` set here are
3037-
/// NOT overridden so a host can pin them per schedule
3040+
/// (model, llmClient, sessionStore, …). `promptSlots` is honored when
3041+
/// provided; otherwise the AgentDir `instructions.md` slot is used.
3042+
/// `sessionId` is always owned by the daemon and set to `schedule:<name>`.
30383043
#[napi]
30393044
pub async fn serve_agent_dir(
30403045
&self,

sdk/python/src/lib.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1146,7 +1146,8 @@ impl PyAgent {
11461146
/// workspace: Path to the workspace directory
11471147
/// options: Optional SessionOptions object
11481148
/// model: Optional model override, format "provider/model" (e.g., "openai/gpt-4o")
1149-
/// builtin_skills: Optional bool to enable built-in skills (default: False)
1149+
/// builtin_skills: Compatibility bool for the built-in skill registry.
1150+
/// Built-ins are present by default; False does not remove them.
11501151
/// skill_dirs: Optional list of directories to scan for skill files
11511152
/// agent_dirs: Optional list of directories to scan for agent files
11521153
/// queue_config: Optional advanced SessionQueueConfig for explicit external/hybrid lane dispatch
@@ -5093,7 +5094,10 @@ impl PySessionOptions {
50935094
self.model = value;
50945095
}
50955096

5096-
/// Enable built-in skills.
5097+
/// Compatibility flag for the built-in skill registry.
5098+
///
5099+
/// Built-ins are present by default. Setting this to False does not remove
5100+
/// them from the effective registry.
50975101
#[getter]
50985102
fn get_builtin_skills(&self) -> bool {
50995103
self.builtin_skills

0 commit comments

Comments
 (0)