bevy_brp_mcp 0.22.2

MCP server for Bevy Remote Protocol (BRP) integration
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

//! `world.get_components` tool - Get component data from entities

use bevy_brp_mcp_macros::ParamStruct;
use bevy_brp_mcp_macros::ResultStruct;
use schemars::JsonSchema;
use serde::Deserialize;
use serde::Serialize;
use serde_json::Value;

use crate::brp_tools::Port;

/// Parameters for the `world.get_components` tool
#[derive(Clone, Deserialize, Serialize, JsonSchema, ParamStruct)]
pub struct GetComponentsParams {
    /// The entity ID to get component data from
    pub entity: u64,

    /// Array of component types to retrieve. Each component must be a fully-qualified type name
    pub components: Vec<String>,

    /// If true, returns error on unknown component types (default: false)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub strict: Option<bool>,

    /// The BRP port (default: 15702)
    #[serde(default)]
    pub port: Port,
}

/// Result for the `world.get_components` tool
#[derive(Serialize, ResultStruct)]
#[brp_result]
pub struct GetComponentsResult {
    /// The raw BRP response with components and errors
    #[serde(skip_serializing_if = "Option::is_none")]
    #[to_result(skip_if_none)]
    result: Option<Value>,

    /// Count of components retrieved - computed from result.components object
    #[serde(rename = "component_count")]
    #[to_metadata(result_operation = "count_components")]
    components: usize,

    /// Count of errors if any components failed to retrieve
    #[serde(rename = "error_count")]
    #[to_metadata(skip_if_none, result_operation = "count_errors")]
    errors: Option<usize>,

    /// Message template for formatting responses
    #[to_message(message_template = "Retrieved {component_count} components")]
    message_template: String,
}