basis 0.8.1

The basis SDK: workspace discovery, run lifecycle, one event stream, and the two seams. No protocol, no transport, no TTY.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
//! The complete host-owned contract for one minted run.
//!
//! A workspace is still the source of defaults. Every `None` at the outer
//! level here means “inherit the workspace”; the nested options on values
//! whose upstream setting is itself optional distinguish inheritance from an
//! explicit clear. Applying a profile therefore never has to guess whether a
//! host omitted a value or deliberately removed one.

use mentra::{ModelInfo, ProviderRequestOptions, ReasoningOptions, ToolResultPagingConfig};

use crate::{compaction::Compaction, context::SystemPrompt};

use super::ToolRoster;

/// Immutable overrides for one run minted from a [`Workspace`](super::Workspace).
///
/// A default profile says nothing and preserves every workspace default.
/// Builder methods return a new value, so a host may keep a common profile and
/// derive narrower variants without shared mutation.
///
/// `ProviderRequestOptions` and the dedicated reasoning override overlap on
/// purpose. Their precedence is ordinary builder order: whichever API is
/// called last decides reasoning. Calling
/// [`with_provider_request_options`](Self::with_provider_request_options)
/// clears an earlier dedicated override; calling
/// [`with_reasoning`](Self::with_reasoning) later replaces only the reasoning
/// inside the complete options and preserves every other provider field.
/// Either profile-level decision outranks legacy [`RunSpec::with_effort`](super::RunSpec::with_effort)
/// regardless of which builder method was called later: the profile is the
/// complete contract, while `effort` is its compatibility fallback.
#[derive(Clone, Default, PartialEq, Eq)]
pub struct RunProfile {
    resolved_model: Option<ModelInfo>,
    tool_roster: Option<ToolRoster>,
    provider_request_options: Option<ProviderRequestOptions>,
    /// Outer `None` inherits; `Some(None)` explicitly clears.
    max_output_tokens: Option<Option<u32>>,
    /// Outer `None` inherits; `Some(None)` explicitly clears.
    reasoning: Option<Option<ReasoningOptions>>,
    compaction: Option<Compaction>,
    /// Outer `None` inherits; `Some(None)` explicitly clears.
    tool_result_paging: Option<Option<ToolResultPagingConfig>>,
    system_prompt: Option<SystemPrompt>,
}

/// Hand-written because provider request options can contain credentials in
/// `session.extra_headers`, while a system prompt can contain arbitrary host
/// data. Presence and set/clear posture are enough to diagnose composition;
/// neither payload belongs in logs.
impl std::fmt::Debug for RunProfile {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("RunProfile")
            .field(
                "resolved_model",
                &self
                    .resolved_model
                    .as_ref()
                    .map(|model| (model.id.as_str(), model.provider.as_str())),
            )
            .field("tool_roster", &set_if(self.tool_roster.as_ref()))
            .field(
                "provider_request_options",
                &redacted_if(self.provider_request_options.as_ref()),
            )
            .field("max_output_tokens", &set_or_clear(&self.max_output_tokens))
            .field("reasoning", &set_or_clear(&self.reasoning))
            .field("compaction", &self.compaction)
            .field(
                "tool_result_paging",
                &set_or_clear(&self.tool_result_paging),
            )
            .field(
                "system_prompt",
                &self.system_prompt.as_ref().map(|prompt| match prompt {
                    SystemPrompt::Replace(_) => "<replace redacted>",
                    SystemPrompt::Append(_) => "<append redacted>",
                }),
            )
            .finish()
    }
}

impl RunProfile {
    /// An empty profile: every value comes from the workspace.
    pub fn new() -> Self {
        Self::default()
    }

    /// Uses complete, already-resolved model metadata for this run.
    ///
    /// No model listing is performed. The model must name the runtime's
    /// registered provider; [`Workspace::prepare`](super::Workspace::prepare)
    /// and [`Workspace::resume`](super::Workspace::resume) reject a mismatch
    /// before minting or resuming a session.
    #[must_use]
    pub fn with_resolved_model(self, model: ModelInfo) -> Self {
        Self {
            resolved_model: Some(model),
            ..self
        }
    }

    /// Offers this exact base roster for the run.
    ///
    /// Per-mint foreign-tool hiding still narrows it afterwards: an exact
    /// roster cannot grant a sibling workspace's declared or MCP tools.
    #[must_use]
    pub fn with_tool_roster(self, tool_roster: ToolRoster) -> Self {
        Self {
            tool_roster: Some(tool_roster),
            ..self
        }
    }

    /// Replaces the complete provider-specific request options for this run.
    ///
    /// This call is also the last word on reasoning at this point in the
    /// builder chain, including when `options.reasoning` is `None`. A later
    /// [`with_reasoning`](Self::with_reasoning) changes only that field.
    ///
    /// Nonempty `options.session.extra_headers` are accepted only when the
    /// runtime was explicitly built with
    /// [`RuntimeBuilder::with_ephemeral_history`](crate::RuntimeBuilder::with_ephemeral_history):
    /// Mentra persists the complete options inside its agent config, so a
    /// durable runtime is refused before mint rather than writing a possible
    /// credential to disk.
    #[must_use]
    pub fn with_provider_request_options(self, options: ProviderRequestOptions) -> Self {
        Self {
            provider_request_options: Some(options),
            reasoning: None,
            ..self
        }
    }

    /// Sets the provider's maximum output tokens, or explicitly clears the
    /// workspace value with `None`.
    #[must_use]
    pub fn with_max_output_tokens(self, max_output_tokens: Option<u32>) -> Self {
        Self {
            max_output_tokens: Some(max_output_tokens),
            ..self
        }
    }

    /// Sets complete reasoning options, or explicitly restores the provider's
    /// default with `None`.
    ///
    /// Called after [`with_provider_request_options`](Self::with_provider_request_options),
    /// this is the last word on that value. Called before it, the later complete
    /// options replace it. Either way a profile reasoning decision outranks
    /// [`RunSpec::with_effort`](super::RunSpec::with_effort), even when the
    /// legacy method was called later.
    #[must_use]
    pub fn with_reasoning(self, reasoning: Option<ReasoningOptions>) -> Self {
        Self {
            reasoning: Some(reasoning),
            ..self
        }
    }

    /// Replaces the workspace's compaction posture for this run.
    #[must_use]
    pub fn with_compaction(self, compaction: Compaction) -> Self {
        Self {
            compaction: Some(compaction),
            ..self
        }
    }

    /// Enables tool-result paging with exact settings, or explicitly disables
    /// an inherited paging posture with `None`.
    #[must_use]
    pub fn with_tool_result_paging(
        self,
        tool_result_paging: Option<ToolResultPagingConfig>,
    ) -> Self {
        Self {
            tool_result_paging: Some(tool_result_paging),
            ..self
        }
    }

    /// Replaces or appends to the workspace's rendered system prompt for this
    /// run, according to [`SystemPrompt`].
    #[must_use]
    pub fn with_system_prompt(self, system_prompt: SystemPrompt) -> Self {
        Self {
            system_prompt: Some(system_prompt),
            ..self
        }
    }

    pub(crate) fn resolved_model(&self) -> Option<&ModelInfo> {
        self.resolved_model.as_ref()
    }

    /// Whether this profile, rather than `RunSpec::effort` or workspace
    /// config, has answered the reasoning question.
    pub(crate) fn decides_reasoning(&self) -> bool {
        self.provider_request_options.is_some() || self.reasoning.is_some()
    }

    /// Whether complete request options contain headers that would be
    /// persisted with a durable Mentra agent config.
    pub(crate) fn has_extra_headers(&self) -> bool {
        self.provider_request_options
            .as_ref()
            .is_some_and(|options| !options.session.extra_headers.is_empty())
    }

    /// A reasoning value Mentra can apply to an already resumed session.
    pub(crate) fn reasoning(&self) -> Option<&Option<ReasoningOptions>> {
        self.reasoning.as_ref()
    }

    /// The first field Mentra 0.22 cannot change on an already resumed agent.
    ///
    /// Model and dedicated reasoning are deliberately absent: `Session`
    /// exposes exact setters for both. Full provider options are present even
    /// if only their reasoning field differs, because accepting a partial
    /// projection would silently drop the rest of the caller's contract.
    pub(crate) fn unsupported_on_resume(&self) -> Option<&'static str> {
        if self.tool_roster.is_some() {
            Some("tool_roster")
        } else if self.provider_request_options.is_some() {
            Some("provider_request_options")
        } else if self.max_output_tokens.is_some() {
            Some("max_output_tokens")
        } else if self.compaction.is_some() {
            Some("compaction")
        } else if self.tool_result_paging.is_some() {
            Some("tool_result_paging")
        } else if self.system_prompt.is_some() {
            Some("system_prompt")
        } else {
            None
        }
    }

    /// Applies every stated field to a cloned workspace agent configuration.
    pub(crate) fn apply_to(
        &self,
        mut agent: mentra::agent::AgentConfig,
    ) -> mentra::agent::AgentConfig {
        if let Some(roster) = &self.tool_roster {
            agent.tool_profile = roster.clone().into_profile();
        }
        if let Some(options) = &self.provider_request_options {
            agent.provider_request_options = options.clone();
        }
        if let Some(reasoning) = &self.reasoning {
            agent.provider_request_options.reasoning = reasoning.clone();
        }
        if let Some(max_output_tokens) = self.max_output_tokens {
            agent.max_output_tokens = max_output_tokens;
        }
        if let Some(compaction) = self.compaction {
            let transcript_dir = agent.compaction.transcript_dir.clone();
            agent.compaction = compaction.into_mentra(transcript_dir);
        }
        if let Some(tool_result_paging) = self.tool_result_paging {
            agent.tool_result_paging = tool_result_paging;
        }
        if let Some(system_prompt) = &self.system_prompt {
            agent.system = apply_system_prompt(agent.system, system_prompt);
        }

        agent
    }
}

fn set_if<T>(value: Option<&T>) -> Option<&'static str> {
    value.map(|_| "<set>")
}

fn redacted_if<T>(value: Option<&T>) -> Option<&'static str> {
    value.map(|_| "<redacted>")
}

fn set_or_clear<T>(value: &Option<Option<T>>) -> Option<&'static str> {
    value
        .as_ref()
        .map(|inner| if inner.is_some() { "<set>" } else { "<clear>" })
}

fn apply_system_prompt(current: Option<String>, profile: &SystemPrompt) -> Option<String> {
    match profile {
        SystemPrompt::Replace(text) => spoken(text),
        SystemPrompt::Append(text) => join(current.and_then(|text| spoken(&text)), spoken(text)),
    }
}

fn spoken(text: &str) -> Option<String> {
    (!text.trim().is_empty()).then(|| text.to_string())
}

fn join(first: Option<String>, second: Option<String>) -> Option<String> {
    match (first, second) {
        (Some(first), Some(second)) => Some(format!("{first}\n\n{second}")),
        (Some(first), None) => Some(first),
        (None, Some(second)) => Some(second),
        (None, None) => None,
    }
}

#[cfg(test)]
mod tests {
    use std::collections::BTreeMap;
    use std::path::PathBuf;

    use super::*;
    use crate::run::Effort;

    fn reasoning(effort: Effort) -> ReasoningOptions {
        ReasoningOptions {
            effort: Some(effort.into()),
            summary: None,
        }
    }

    #[test]
    fn an_empty_profile_changes_nothing() {
        let mut agent = mentra::agent::AgentConfig {
            system: Some("workspace".to_string()),
            max_output_tokens: Some(777),
            tool_result_paging: Some(ToolResultPagingConfig {
                threshold_bytes: 10,
                page_bytes: 5,
            }),
            ..Default::default()
        };
        agent.provider_request_options.reasoning = Some(reasoning(Effort::Low));

        let applied = RunProfile::new().apply_to(agent.clone());
        assert_eq!(
            serde_json::to_value(applied).expect("applied config serializes"),
            serde_json::to_value(agent).expect("original config serializes")
        );
    }

    #[test]
    fn nested_options_distinguish_clear_from_inherit() {
        let mut agent = mentra::agent::AgentConfig {
            max_output_tokens: Some(777),
            tool_result_paging: Some(ToolResultPagingConfig {
                threshold_bytes: 10,
                page_bytes: 5,
            }),
            ..Default::default()
        };
        agent.provider_request_options.reasoning = Some(reasoning(Effort::Low));

        let cleared = RunProfile::new()
            .with_max_output_tokens(None)
            .with_reasoning(None)
            .with_tool_result_paging(None)
            .apply_to(agent);

        assert_eq!(cleared.max_output_tokens, None);
        assert_eq!(cleared.provider_request_options.reasoning, None);
        assert_eq!(cleared.tool_result_paging, None);
    }

    #[test]
    fn compaction_and_paging_reach_the_final_agent_without_moving_transcripts() {
        let transcript_dir = PathBuf::from("/host/runtime/transcripts");
        let agent = mentra::agent::AgentConfig {
            compaction: mentra::agent::CompactionConfig {
                transcript_dir: transcript_dir.clone(),
                ..Default::default()
            },
            ..Default::default()
        };
        let paging = ToolResultPagingConfig {
            threshold_bytes: 128 * 1024,
            page_bytes: 16 * 1024,
        };

        let applied = RunProfile::new()
            .with_compaction(
                Compaction::default()
                    .with_keep_recent_tool_results(Some(2))
                    .with_auto_threshold_tokens(Some(12_345))
                    .with_auto_threshold_percent(Some(60))
                    .with_preserve_recent_user_tokens(777),
            )
            .with_tool_result_paging(Some(paging))
            .apply_to(agent);

        assert_eq!(applied.compaction.keep_recent_tool_results, 2);
        assert_eq!(
            applied.compaction.auto_compact_threshold_tokens,
            Some(12_345)
        );
        assert_eq!(applied.compaction.auto_compact_threshold_percent, Some(60));
        assert_eq!(applied.compaction.preserve_recent_user_tokens, 777);
        assert_eq!(applied.compaction.transcript_dir, transcript_dir);
        assert_eq!(applied.tool_result_paging, Some(paging));
    }

    #[test]
    fn system_append_keeps_the_workspace_prompt_and_lands_last() {
        let agent = mentra::agent::AgentConfig {
            system: Some("workspace".to_string()),
            ..Default::default()
        };

        let applied = RunProfile::new()
            .with_system_prompt(SystemPrompt::Append("host".to_string()))
            .apply_to(agent);

        assert_eq!(applied.system.as_deref(), Some("workspace\n\nhost"));
    }

    #[test]
    fn later_reasoning_call_wins_without_losing_other_request_fields() {
        let mut options = ProviderRequestOptions {
            reasoning: Some(reasoning(Effort::Low)),
            ..Default::default()
        };
        options.responses.service_tier = Some("priority".to_string());

        let applied = RunProfile::new()
            .with_provider_request_options(options)
            .with_reasoning(Some(reasoning(Effort::High)))
            .apply_to(mentra::agent::AgentConfig::default());

        assert_eq!(
            applied.provider_request_options.reasoning,
            Some(reasoning(Effort::High))
        );
        assert_eq!(
            applied
                .provider_request_options
                .responses
                .service_tier
                .as_deref(),
            Some("priority")
        );
    }

    #[test]
    fn later_complete_options_replace_an_earlier_reasoning_override() {
        let options = ProviderRequestOptions {
            reasoning: Some(reasoning(Effort::Low)),
            ..Default::default()
        };
        let applied = RunProfile::new()
            .with_reasoning(Some(reasoning(Effort::High)))
            .with_provider_request_options(options)
            .apply_to(mentra::agent::AgentConfig::default());

        assert_eq!(
            applied.provider_request_options.reasoning,
            Some(reasoning(Effort::Low))
        );
    }

    #[test]
    fn debug_redacts_headers_and_system_text() {
        let mut options = ProviderRequestOptions::default();
        options.session.extra_headers =
            BTreeMap::from([("authorization".to_string(), "Bearer secret".to_string())]);
        let profile = RunProfile::new()
            .with_provider_request_options(options)
            .with_system_prompt(SystemPrompt::Replace("private instructions".to_string()));

        let rendered = format!("{profile:?}");

        assert!(!rendered.contains("Bearer secret"));
        assert!(!rendered.contains("private instructions"));
        assert!(rendered.contains("<redacted>"));
    }
}