feat: define core types and interfaces

a2a/agent.go

@@ -0,0 +1,222 @@
+// Copyright 2025 The A2A Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package a2a
+
+// Defines optional capabilities supported by an agent.
+type AgentCapabilities struct {
+	// A list of protocol extensions supported by the agent.
+	Extensions []AgentExtension
+
+	// Indicates if the agent supports sending push notifications for asynchronous
+	// task updates.
+	PushNotifications *bool
+
+	// Indicates if the agent provides a history of state transitions for a task.
+	StateTransitionHistory *bool
+
+	// Indicates if the agent supports Server-Sent Events (SSE) for streaming
+	// responses.
+	Streaming *bool
+}
+
+// The AgentCard is a self-describing manifest for an agent. It provides essential
+// metadata including the agent's identity, capabilities, skills, supported
+// communication methods, and security requirements.
+type AgentCard struct {
+	// A list of additional supported interfaces (transport and URL combinations).
+	// This allows agents to expose multiple transports, potentially at different
+	// URLs.
+	//
+	// Best practices:
+	// - SHOULD include all supported transports for completeness
+	// - SHOULD include an entry matching the main 'url' and 'preferredTransport'
+	// - MAY reuse URLs if multiple transports are available at the same endpoint
+	// - MUST accurately declare the transport available at each URL
+	//
+	// Clients can select any interface from this list based on their transport
+	// capabilities
+	// and preferences. This enables transport negotiation and fallback scenarios.
+	AdditionalInterfaces []AgentInterface
+
+	// A declaration of optional capabilities supported by the agent.
+	Capabilities AgentCapabilities
+
+	// Default set of supported input MIME types for all skills, which can be
+	// overridden on a per-skill basis.
+	DefaultInputModes []string
+
+	// Default set of supported output MIME types for all skills, which can be
+	// overridden on a per-skill basis.
+	DefaultOutputModes []string
+
+	// A human-readable description of the agent, assisting users and other agents
+	// in understanding its purpose.
+	Description string
+
+	// An optional URL to the agent's documentation.
+	DocumentationURL *string
+
+	// An optional URL to an icon for the agent.
+	IconURL *string
+
+	// A human-readable name for the agent.
+	Name string
+
+	// The transport protocol for the preferred endpoint (the main 'url' field).
+	// If not specified, defaults to 'JSONRPC'.
+	//
+	// IMPORTANT: The transport specified here MUST be available at the main 'url'.
+	// This creates a binding between the main URL and its supported transport
+	// protocol.
+	// Clients should prefer this transport and URL combination when both are
+	// supported.
+	PreferredTransport TransportProtocol
+
+	// The version of the A2A protocol this agent supports.
+	ProtocolVersion string
+
+	// Information about the agent's service provider.
+	Provider *AgentProvider
+
+	// A list of security requirement objects that apply to all agent interactions.
+	// Each object
+	// lists security schemes that can be used. Follows the OpenAPI 3.0 Security
+	// Requirement Object.
+	// This list can be seen as an OR of ANDs. Each object in the list describes one
+	// possible
+	// set of security requirements that must be present on a request. This allows
+	// specifying,
+	// for example, "callers must either use OAuth OR an API Key AND mTLS."
+	Security []map[string][]string
+
+	// A declaration of the security schemes available to authorize requests. The key
+	// is the
+	// scheme name. Follows the OpenAPI 3.0 Security Scheme Object.
+	SecuritySchemes map[string]any
+
+	// JSON Web Signatures computed for this AgentCard.
+	Signatures []AgentCardSignature
+
+	// The set of skills, or distinct capabilities, that the agent can perform.
+	Skills []AgentSkill
+
+	// If true, the agent can provide an extended agent card with additional details
+	// to authenticated users. Defaults to false.
+	SupportsAuthenticatedExtendedCard *bool
+
+	// The preferred endpoint URL for interacting with the agent.
+	// This URL MUST support the transport specified by 'preferredTransport'.
+	URL string
+
+	// The agent's own version number. The format is defined by the provider.
+	Version string
+}
+
+// AgentCardSignature represents a JWS signature of an AgentCard.
+// This follows the JSON format of an RFC 7515 JSON Web Signature (JWS).
+type AgentCardSignature struct {
+	// The unprotected JWS header values.
+	Header map[string]any
+
+	// The protected JWS header for the signature. This is a Base64url-encoded
+	// JSON object, as per RFC 7515.
+	Protected string
+
+	// The computed signature, Base64url-encoded.
+	Signature string
+}
+
+// A declaration of a protocol extension supported by an Agent.
+type AgentExtension struct {
+	// A human-readable description of how this agent uses the extension.
+	Description *string
+
+	// Optional, extension-specific configuration parameters.
+	Params map[string]any
+
+	// If true, the client must understand and comply with the extension's
+	// requirements
+	// to interact with the agent.
+	Required *bool
+
+	// The unique URI identifying the extension.
+	URI string
+}
+
+// Declares a combination of a target URL and a transport protocol for interacting
+// with the agent.
+// This allows agents to expose the same functionality over multiple transport
+// mechanisms.
+type AgentInterface struct {
+	// The transport protocol supported at this URL.
+	Transport string
+
+	// The URL where this interface is available. Must be a valid absolute HTTPS URL
+	// in production.
+	URL string
+}
+
+// Represents the service provider of an agent.
+type AgentProvider struct {
+	// The name of the agent provider's organization.
+	Org string
+
+	// A URL for the agent provider's website or relevant documentation.
+	URL string
+}
+
+// Represents a distinct capability or function that an agent can perform.
+type AgentSkill struct {
+	// A detailed description of the skill, intended to help clients or users
+	// understand its purpose and functionality.
+	Description string
+
+	// Example prompts or scenarios that this skill can handle. Provides a hint to
+	// the client on how to use the skill.
+	Examples []string
+
+	// A unique identifier for the agent's skill.
+	ID string
+
+	// The set of supported input MIME types for this skill, overriding the agent's
+	// defaults.
+	InputModes []string
+
+	// A human-readable name for the skill.
+	Name string
+
+	// The set of supported output MIME types for this skill, overriding the agent's
+	// defaults.
+	OutputModes []string
+
+	// Security schemes necessary for the agent to leverage this skill.
+	// As in the overall AgentCard.security, this list represents a logical OR of
+	// security
+	// requirement objects. Each object is a set of security schemes that must be used
+	// together
+	// (a logical AND).
+	Security []map[string][]string
+
+	// A set of keywords describing the skill's capabilities.
+	Tags []string
+}
+
+type TransportProtocol string
+
+const (
+	TransportProtocolJSONRPC  TransportProtocol = "JSONRPC"
+	TransportProtocolGRPC     TransportProtocol = "GRPC"
+	TransportProtocolHTTPJSON TransportProtocol = "HTTP+JSON"
+)