protocol-profile

Generated reference page for spec/v1/schemas/common/protocol-profile.json.

Metadata

• Type: JSON Schema
• Source: spec/v1/schemas/common/protocol-profile.json
• Raw: View Raw

Summary

• Schema ID: https://agent-service.spec/v1/schemas/common/protocol-profile.json
• Defs: 27
• Properties: 0
• Required: 0

Source

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://agent-service.spec/v1/schemas/common/protocol-profile.json",
  "$defs": {
    "ProtocolSecurityRequirement": {
      "type": "object",
      "additionalProperties": false,
      "required": ["scheme"],
      "properties": {
        "scheme": {
          "type": "string",
          "minLength": 1
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "optional": {
          "type": "boolean",
          "default": false
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "ProtocolTransport": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name"],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "streaming": {
          "type": "boolean"
        },
        "resumable": {
          "type": "boolean"
        },
        "push": {
          "type": "boolean"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "IdentityProjection": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "name": {
          "type": "string"
        },
        "title": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "version": {
          "type": "string"
        },
        "provider": {
          "type": "string"
        },
        "documentationUrl": {
          "type": "string",
          "format": "uri"
        },
        "iconUrl": {
          "type": "string",
          "format": "uri"
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "SkillProjection": {
      "type": "object",
      "additionalProperties": false,
      "required": ["id", "name"],
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1
        },
        "name": {
          "type": "string",
          "minLength": 1
        },
        "description": {
          "type": "string"
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "examples": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "inputModes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "outputModes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "metadata": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "ProtocolExtension": {
      "type": "object",
      "additionalProperties": false,
      "required": ["name"],
      "properties": {
        "name": {
          "type": "string",
          "minLength": 1
        },
        "uri": {
          "type": "string",
          "format": "uri"
        },
        "required": {
          "type": "boolean",
          "default": false
        },
        "config": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "BaseProtocolProfile": {
      "type": "object",
      "additionalProperties": false,
      "required": ["protocolVersion", "capabilities"],
      "properties": {
        "protocolVersion": {
          "type": "string",
          "minLength": 1
        },
        "inputModes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "outputModes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "identityProjection": {
          "$ref": "#/$defs/IdentityProjection"
        },
        "skillsProjection": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/SkillProjection"
          }
        },
        "extensions": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ProtocolExtension"
          }
        }
      }
    },
    "A2AProtocolCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "streaming": {
          "type": "boolean"
        },
        "pushNotifications": {
          "type": "boolean"
        },
        "extendedAgentCard": {
          "type": "boolean"
        },
        "signedAgentCard": {
          "type": "boolean"
        },
        "multiInterface": {
          "type": "boolean"
        },
        "stateTransitionHistory": {
          "type": "boolean"
        },
        "custom": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "A2AProtocolProfile": {
      "allOf": [
        {
          "$ref": "#/$defs/BaseProtocolProfile"
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "capabilities": {
              "$ref": "#/$defs/A2AProtocolCapabilities"
            }
          }
        }
      ]
    },
    "ACPProtocolPromptCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "image": {
          "type": "boolean"
        },
        "audio": {
          "type": "boolean"
        },
        "embeddedContext": {
          "type": "boolean"
        }
      }
    },
    "ACPProtocolFilesystemCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "readTextFile": {
          "type": "boolean"
        },
        "writeTextFile": {
          "type": "boolean"
        }
      }
    },
    "ACPProtocolMCPCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "http": {
          "type": "boolean"
        },
        "sse": {
          "type": "boolean"
        }
      }
    },
    "ACPProtocolCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "loadSession": {
          "type": "boolean"
        },
        "sessionList": {
          "type": "boolean"
        },
        "sessionInfoUpdate": {
          "type": "boolean"
        },
        "sessionModes": {
          "type": "boolean"
        },
        "slashCommands": {
          "type": "boolean"
        },
        "permissions": {
          "type": "boolean"
        },
        "terminal": {
          "type": "boolean"
        },
        "prompt": {
          "$ref": "#/$defs/ACPProtocolPromptCapabilities"
        },
        "fs": {
          "$ref": "#/$defs/ACPProtocolFilesystemCapabilities"
        },
        "mcp": {
          "$ref": "#/$defs/ACPProtocolMCPCapabilities"
        },
        "custom": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "ACPProtocolProfile": {
      "allOf": [
        {
          "$ref": "#/$defs/BaseProtocolProfile"
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "capabilities": {
              "$ref": "#/$defs/ACPProtocolCapabilities"
            }
          }
        }
      ]
    },
    "AGUITransportCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "streaming": {
          "type": "boolean"
        },
        "websocket": {
          "type": "boolean"
        },
        "httpBinary": {
          "type": "boolean"
        },
        "pushNotifications": {
          "type": "boolean"
        },
        "resumable": {
          "type": "boolean"
        }
      }
    },
    "AGUIToolCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "supported": {
          "type": "boolean"
        },
        "parallelCalls": {
          "type": "boolean"
        },
        "clientProvided": {
          "type": "boolean"
        }
      }
    },
    "AGUIStateCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "snapshots": {
          "type": "boolean"
        },
        "deltas": {
          "type": "boolean"
        },
        "persistentState": {
          "type": "boolean"
        }
      }
    },
    "AGUIReasoningCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "supported": {
          "type": "boolean"
        },
        "streaming": {
          "type": "boolean"
        },
        "encrypted": {
          "type": "boolean"
        }
      }
    },
    "AGUIMultiAgentCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "supported": {
          "type": "boolean"
        },
        "delegation": {
          "type": "boolean"
        },
        "handoffs": {
          "type": "boolean"
        }
      }
    },
    "AGUIMultimodalInputCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "image": {
          "type": "boolean"
        },
        "audio": {
          "type": "boolean"
        },
        "video": {
          "type": "boolean"
        },
        "pdf": {
          "type": "boolean"
        },
        "file": {
          "type": "boolean"
        }
      }
    },
    "AGUIMultimodalOutputCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "image": {
          "type": "boolean"
        },
        "audio": {
          "type": "boolean"
        }
      }
    },
    "AGUIMultimodalCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "input": {
          "$ref": "#/$defs/AGUIMultimodalInputCapabilities"
        },
        "output": {
          "$ref": "#/$defs/AGUIMultimodalOutputCapabilities"
        }
      }
    },
    "AGUIHumanInTheLoopCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "supported": {
          "type": "boolean"
        },
        "approvals": {
          "type": "boolean"
        },
        "interventions": {
          "type": "boolean"
        },
        "feedback": {
          "type": "boolean"
        }
      }
    },
    "AGUIProtocolCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "transport": {
          "$ref": "#/$defs/AGUITransportCapabilities"
        },
        "tools": {
          "$ref": "#/$defs/AGUIToolCapabilities"
        },
        "state": {
          "$ref": "#/$defs/AGUIStateCapabilities"
        },
        "reasoning": {
          "$ref": "#/$defs/AGUIReasoningCapabilities"
        },
        "multiAgent": {
          "$ref": "#/$defs/AGUIMultiAgentCapabilities"
        },
        "multimodal": {
          "$ref": "#/$defs/AGUIMultimodalCapabilities"
        },
        "humanInTheLoop": {
          "$ref": "#/$defs/AGUIHumanInTheLoopCapabilities"
        },
        "structuredOutput": {
          "type": "boolean"
        },
        "custom": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "AGUIProtocolProfile": {
      "allOf": [
        {
          "$ref": "#/$defs/BaseProtocolProfile"
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "capabilities": {
              "$ref": "#/$defs/AGUIProtocolCapabilities"
            }
          }
        }
      ]
    },
    "MCPProtocolCapabilities": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "toolList": {
          "type": "boolean"
        },
        "toolCall": {
          "type": "boolean"
        },
        "resources": {
          "type": "boolean"
        },
        "prompts": {
          "type": "boolean"
        },
        "custom": {
          "type": "object",
          "additionalProperties": true
        }
      }
    },
    "MCPProtocolProfile": {
      "allOf": [
        {
          "$ref": "#/$defs/BaseProtocolProfile"
        },
        {
          "type": "object",
          "additionalProperties": false,
          "properties": {
            "capabilities": {
              "$ref": "#/$defs/MCPProtocolCapabilities"
            }
          }
        }
      ]
    },
    "ProtocolProfiles": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "a2a": {
          "$ref": "#/$defs/A2AProtocolProfile"
        },
        "acp": {
          "$ref": "#/$defs/ACPProtocolProfile"
        },
        "agui": {
          "$ref": "#/$defs/AGUIProtocolProfile"
        }
      }
    }
  }
}