chromewright 0.8.0

Browser automation MCP server via Chrome DevTools Protocol (CDP)
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

//! Element targeting input and resolution metadata for MCP tools.
//!
//! [`PublicTarget`] is the exclusive MCP input (selector or revision-scoped
//! cursor). [`TargetEnvelope`] reports how resolution ran, including stale-cursor
//! recovery. [`TargetStatus`] classifies post-mutation continuity for agents.

use crate::dom::{Cursor, NodeRef};
use schemars::{JsonSchema, Schema, SchemaGenerator};
use serde::de::Deserializer;
use std::borrow::Cow;

/// Resolved target handed between tools, including stale-cursor recovery status.
///
/// Carries the resolution method (`selector` / `cursor`), whether recovery rewrote
/// a stale cursor, and the revision-scoped handles agents reuse for follow-up tools.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, schemars::JsonSchema)]
pub struct TargetEnvelope {
    /// How the target was resolved (for example `selector` or `cursor`).
    pub method: String,
    /// Resolution outcome: typically `exact`, or a recovery status after rebinding.
    #[serde(default = "default_target_resolution_status")]
    pub resolution_status: String,
    /// Prior handle when stale-cursor recovery rebound to a new node.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub recovered_from: Option<String>,
    /// Revision-scoped cursor for follow-up interaction tools.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub cursor: Option<Cursor>,
    /// Revision-scoped node reference from snapshot indexing.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub node_ref: Option<NodeRef>,
    /// CSS selector when that was the resolution method.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub selector: Option<String>,
    /// Interactive index within the snapshot when resolved by index.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub index: Option<usize>,
}

fn default_target_resolution_status() -> String {
    "exact".to_string()
}

/// MCP tool input for targeting an element by selector or revision-scoped cursor.
#[derive(Debug, Clone, serde::Serialize, PartialEq, Eq)]
#[serde(tag = "kind", rename_all = "snake_case", deny_unknown_fields)]
pub enum PublicTarget {
    /// Resolve the target from a selector in the current document.
    Selector { selector: String },
    /// Reuse a revision-scoped cursor from `snapshot` or `inspect_node`.
    Cursor { cursor: Cursor },
}

#[derive(Debug, Clone, serde::Deserialize, JsonSchema)]
#[serde(tag = "kind", rename_all = "snake_case", deny_unknown_fields)]
enum TaggedPublicTarget {
    Selector { selector: String },
    Cursor { cursor: Cursor },
}

#[derive(Debug, Clone, serde::Deserialize, JsonSchema)]
#[serde(untagged)]
enum PublicTargetCompat {
    SelectorString(String),
    Tagged(TaggedPublicTarget),
}

impl<'de> serde::Deserialize<'de> for PublicTarget {
    fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        match PublicTargetCompat::deserialize(deserializer)? {
            PublicTargetCompat::SelectorString(selector) => Ok(Self::Selector { selector }),
            PublicTargetCompat::Tagged(TaggedPublicTarget::Selector { selector }) => {
                Ok(Self::Selector { selector })
            }
            PublicTargetCompat::Tagged(TaggedPublicTarget::Cursor { cursor }) => {
                Ok(Self::Cursor { cursor })
            }
        }
    }
}

impl JsonSchema for PublicTarget {
    fn schema_name() -> Cow<'static, str> {
        "PublicTarget".into()
    }

    fn json_schema(generator: &mut SchemaGenerator) -> Schema {
        PublicTargetCompat::json_schema(generator)
    }
}

impl PublicTarget {
    /// Split into exclusive selector or cursor handles for shared target resolution.
    pub(crate) fn into_selector_or_cursor(self) -> (Option<String>, Option<Cursor>) {
        match self {
            Self::Selector { selector } => (Some(selector), None),
            Self::Cursor { cursor } => (None, Some(cursor)),
        }
    }
}

/// Whether an interaction left the resolved target unchanged, rebound, or detached.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize, JsonSchema, PartialEq, Eq)]
#[serde(rename_all = "snake_case")]
pub enum TargetStatus {
    /// Post-action probe still resolves the same node as `target_before`.
    Same,
    /// Target was rebound (for example via stale-cursor recovery) to a different node.
    Rebound,
    /// Target no longer resolves after the mutation.
    Detached,
    /// Post-action target status could not be determined.
    Unknown,
}