Connection

Connection configuration for AI agents. provider, kind, and endpoint are required properties here, but this section can accept additional via options.

Class Diagram

---
title: Connection
config:
  look: handDrawn
  theme: colorful
  class:
    hideEmptyMembersBox: true
---
classDiagram
    class Connection {
      <>
        +string kind
        +string authenticationMode
        +string usageDescription
    }
    class ReferenceConnection {
        +string kind
        +string name
        +string target
    }
    Connection <|-- ReferenceConnection
    class RemoteConnection {
        +string kind
        +string name
        +string endpoint
    }
    Connection <|-- RemoteConnection
    class ApiKeyConnection {
        +string kind
        +string endpoint
        +string apiKey
    }
    Connection <|-- ApiKeyConnection
    class AnonymousConnection {
        +string kind
        +string endpoint
    }
    Connection <|-- AnonymousConnection

Yaml Example

kind: reference
authenticationMode: system
usageDescription: This will allow the agent to respond to an email on your behalf

Properties

Name	Type	Description
kind	string	The Authentication kind for the AI service (e.g., ‘key’ for API key, ‘oauth’ for OAuth tokens)
authenticationMode	string	The authority level for the connection, indicating under whose authority the connection is made (e.g., ‘user’, ‘agent’, ‘system’)
usageDescription	string	The usage description for the connection, providing context on how this connection will be used

Child Types

The following types extend Connection:

• ReferenceConnection
• RemoteConnection
• ApiKeyConnection
• AnonymousConnection