Skip to main content

systemprompt_models/a2a/agent_card/
mod.rs

1//! A2A protocol agent card — the JSON document an agent publishes to
2//! describe its identity, capabilities, transports, and skills.
3
4mod extension;
5mod skill;
6
7pub use extension::{ARTIFACT_RENDERING_URI, AgentCapabilities, AgentExtension};
8pub use skill::{AgentCardSignature, AgentInterface, AgentProvider, AgentSkill};
9
10use serde::{Deserialize, Serialize};
11use std::collections::HashMap;
12
13use super::security::SecurityScheme;
14use super::transport::ProtocolBinding;
15
16#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Default)]
17#[serde(rename_all = "camelCase")]
18pub struct AgentCard {
19    pub name: String,
20    pub description: String,
21    pub supported_interfaces: Vec<AgentInterface>,
22    pub version: String,
23    #[serde(skip_serializing_if = "Option::is_none")]
24    pub icon_url: Option<String>,
25    #[serde(skip_serializing_if = "Option::is_none")]
26    pub provider: Option<AgentProvider>,
27    #[serde(skip_serializing_if = "Option::is_none")]
28    pub documentation_url: Option<String>,
29    pub capabilities: AgentCapabilities,
30    #[serde(skip_serializing_if = "Option::is_none")]
31    pub security_schemes: Option<HashMap<String, SecurityScheme>>,
32    #[serde(skip_serializing_if = "Option::is_none")]
33    pub security: Option<Vec<HashMap<String, Vec<String>>>>,
34    pub default_input_modes: Vec<String>,
35    pub default_output_modes: Vec<String>,
36    #[serde(default)]
37    pub skills: Vec<AgentSkill>,
38    #[serde(default, skip_serializing_if = "Option::is_none")]
39    pub supports_authenticated_extended_card: Option<bool>,
40    #[serde(skip_serializing_if = "Option::is_none")]
41    pub signatures: Option<Vec<AgentCardSignature>>,
42}
43
44impl AgentCard {
45    #[must_use]
46    pub fn builder(
47        name: String,
48        description: String,
49        url: String,
50        version: String,
51    ) -> AgentCardBuilder {
52        AgentCardBuilder::new(name, description, url, version)
53    }
54
55    #[must_use]
56    pub fn url(&self) -> Option<&str> {
57        self.supported_interfaces.first().map(|i| i.url.as_str())
58    }
59
60    #[must_use]
61    pub fn has_mcp_extension(&self) -> bool {
62        self.capabilities
63            .extensions
64            .as_ref()
65            .is_some_and(|exts| exts.iter().any(|ext| ext.uri == "systemprompt:mcp-tools"))
66    }
67
68    pub fn ensure_mcp_extension(&mut self) {
69        if self.has_mcp_extension() {
70            return;
71        }
72
73        self.capabilities
74            .extensions
75            .get_or_insert_with(Vec::new)
76            .push(AgentExtension::mcp_tools_extension());
77    }
78}
79
80#[derive(Debug)]
81pub struct AgentCardBuilder {
82    agent_card: AgentCard,
83}
84
85impl AgentCardBuilder {
86    #[must_use]
87    pub fn new(name: String, description: String, url: String, version: String) -> Self {
88        Self {
89            agent_card: AgentCard {
90                name,
91                description,
92                supported_interfaces: vec![AgentInterface {
93                    url,
94                    protocol_binding: ProtocolBinding::JsonRpc,
95                    protocol_version: "1.0.0".to_owned(),
96                }],
97                version,
98                icon_url: None,
99                provider: None,
100                documentation_url: None,
101                capabilities: AgentCapabilities::default(),
102                security_schemes: None,
103                security: None,
104                default_input_modes: vec!["text/plain".to_owned()],
105                default_output_modes: vec!["text/plain".to_owned()],
106                skills: Vec::new(),
107                supports_authenticated_extended_card: Some(false),
108                signatures: None,
109            },
110        }
111    }
112
113    #[must_use]
114    pub const fn with_streaming(mut self) -> Self {
115        self.agent_card.capabilities.streaming = Some(true);
116        self
117    }
118
119    #[must_use]
120    pub const fn with_push_notifications(mut self) -> Self {
121        self.agent_card.capabilities.push_notifications = Some(true);
122        self
123    }
124
125    #[must_use]
126    pub fn with_provider(mut self, organization: String, url: String) -> Self {
127        self.agent_card.provider = Some(AgentProvider { organization, url });
128        self
129    }
130
131    #[must_use]
132    pub fn build(self) -> AgentCard {
133        self.agent_card
134    }
135}