objectiveai-sdk 2.2.11

ObjectiveAI SDK, definitions, and utilities
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

//! Discriminator identifying which CLI-hosted MCP server a frame
//! addresses. Lives at the module root so [`super::server_request`],
//! [`super::server_response`], and [`super::client_request`] can
//! all reach it without circular `super::super::` chains.

use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

/// Which CLI-hosted MCP server a frame belongs to. Stamped on every
/// [`super::server_request::Request`] / [`super::server_response::Response`]
/// envelope and on every [`super::client_request::McpListChanged`]
/// payload so the CLI's per-MCP dispatch table can route by enum
/// rather than by parsing the proxy's URL path on every hop.
///
/// Wire shape: `{"type":"objective_ai"}`,
/// `{"type":"plugin","owner":"…","name":"…","version":"…","mcp":"…"}`, or
/// `{"type":"laboratory","id":"…"}`.
///
/// The four discriminator fields on `Plugin` mirror the API's
/// `/{owner}/{name}/{version}/{mcp}` URL path that the proxy dials
/// for plugin-hosted MCP servers.
#[derive(
    Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize, JsonSchema,
)]
#[schemars(rename = "client_objectiveai_mcp.McpKind")]
#[serde(tag = "type", rename_all = "snake_case")]
pub enum McpKind {
    /// The CLI's primary `objectiveai-mcp` upstream — the local MCP
    /// server bound at the CLI process's `--mcp-address`.
    #[schemars(title = "ObjectiveAI")]
    ObjectiveAi,

    /// A plugin-hosted MCP server. Identified by the plugin's
    /// `(owner, name, version)` tuple plus the `mcp` server name
    /// within that plugin's manifest. Mirrors the API URL
    /// `/{owner}/{name}/{version}/{mcp}` and the agent declaration's
    /// `plugins[i].{owner,name,version}.mcp_servers[j].name`.
    #[schemars(title = "Plugin")]
    Plugin {
        owner: String,
        name: String,
        version: String,
        mcp: String,
    },

    /// A laboratory-hosted MCP server, identified by an opaque `id`.
    /// Mirrors the proxy URL `ws://laboratory/{id}`. Laboratory ids
    /// are only unique per (machine, state); `machine` +
    /// `machine_state` pin the exact laboratory host so the CLI
    /// conduit forwards precisely — an absent pair falls back to
    /// legacy first-match-by-id resolution.
    #[schemars(title = "Laboratory")]
    Laboratory {
        id: String,
        #[serde(default, skip_serializing_if = "Option::is_none")]
        #[schemars(extend("omitempty" = true))]
        machine: Option<String>,
        #[serde(default, skip_serializing_if = "Option::is_none")]
        #[schemars(extend("omitempty" = true))]
        machine_state: Option<String>,
        /// For agent-embedded laboratories: the seed the CLI conduit
        /// needs to CREATE the laboratory when no connected host
        /// serves the derived `id` yet (reuse needs only the id).
        /// `None` for user-created laboratories.
        #[serde(default, skip_serializing_if = "Option::is_none")]
        #[schemars(extend("omitempty" = true))]
        agent: Option<AgentLaboratorySeed>,
    },
}

/// The seed of an agent-embedded laboratory, riding
/// [`McpKind::Laboratory`]: the source agent's full id plus the
/// embedded spec — everything the CLI conduit's on-the-fly create
/// needs.
#[derive(
    Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize, JsonSchema,
)]
#[schemars(rename = "client_objectiveai_mcp.AgentLaboratorySeed")]
pub struct AgentLaboratorySeed {
    /// The full id of the agent the laboratory derives from.
    pub agent_full_id: String,
    /// The embedded laboratory spec (image, env, cwd).
    pub laboratory: crate::agent::Laboratory,
}