Merge branch 'main' into automate-readme

Author: allisoneer

README.md

@@ -139,7 +139,8 @@ spec:
   apiKeyFrom:
     secretKeyRef:
       name: openai
-      key: OPENAI_API_KEY' | kubectl apply -f -
+      key: OPENAI_API_KEY
+' | kubectl apply -f -
 ```
 
 ```mermaid
@@ -231,7 +232,8 @@ spec:
   llmRef:
     name: gpt-4o
   system: |
-    You are a helpful assistant. Your job is to help the user with their tasks.' | kubectl apply -f -
+    You are a helpful assistant. Your job is to help the user with their tasks.
+' | kubectl apply -f -
 ```
 
 ```mermaid
@@ -329,7 +331,8 @@ metadata:
 spec:
   agentRef:
     name: my-assistant
-  userMessage: "What is the capital of the moon?"' | kubectl apply -f -
+  userMessage: "What is the capital of the moon?"
+' | kubectl apply -f -
 ```
 
 ```mermaid
@@ -525,7 +528,8 @@ metadata:
 spec:
   transport: "stdio"
   command: "uvx"
-  args: ["mcp-server-fetch"]' | kubectl apply -f -
+  args: ["mcp-server-fetch"]
+' | kubectl apply -f -
 ```
 
 ```bash
@@ -603,7 +607,8 @@ spec:
   system: |
     You are a helpful assistant. Your job is to help the user with their tasks.
   mcpServers:
-    - name: fetch' | kubectl apply -f -
+    - name: fetch
+' | kubectl apply -f -
 ```
 
 ```mermaid
@@ -645,7 +650,8 @@ metadata:
 spec:
   agentRef:
     name: my-assistant
-  userMessage: "what is the data at https://lotrapi.co/api/v1/characters/1? "' | kubectl apply -f -
+  userMessage: "what is the data at https://lotrapi.co/api/v1/characters/1? "
+' | kubectl apply -f -
 ```
 
 You should see some events in the output of
@@ -859,7 +865,8 @@ spec:
   apiKeyFrom:
     secretKeyRef:
       name: anthropic
-      key: ANTHROPIC_API_KEY' | kubectl apply -f -
+      key: ANTHROPIC_API_KEY
+' | kubectl apply -f -
 ```
 
 fetch the LLM to verify it was created:
@@ -884,7 +891,8 @@ spec:
   llmRef:
     name: claude-3-5-sonnet
   system: |
-    You are a helpful assistant. Your job is to help the user with their tasks.' | kubectl apply -f -
+    You are a helpful assistant. Your job is to help the user with their tasks.
+' | kubectl apply -f -
 ```
 
 ```bash
@@ -895,7 +903,8 @@ metadata:
 spec:
   agentRef:
     name: claude
-  userMessage: "What is your name and primary directive?"' | kubectl apply -f -
+  userMessage: "What is your name and primary directive?"
+' | kubectl apply -f -
 ```
 
 After a few seconds, running 
@@ -917,7 +926,7 @@ We can compose agents together to create more complex behaviors and make longer
 Let's create a web search agent that can use the fetch tool we created in the previous example.
 
 ```bash
-cat <<EOF | kubectl apply -f -
+echo '
 apiVersion: acp.humanlayer.dev/v1alpha1
 kind: Agent
 metadata:
@@ -929,13 +938,13 @@ spec:
     You are a helpful assistant. Your job is to help the user with their tasks.
   mcpServers:
     - name: fetch
-EOF
+' | kubectl apply -f -
 ```
 
 next, we can create a router agent that can delegate to the web search agent.
 
 ```bash
-cat <<EOF | kubectl apply -f -
+echo '
 apiVersion: acp.humanlayer.dev/v1alpha1
 kind: Agent
 metadata:
@@ -947,13 +956,13 @@ spec:
     You are a helpful assistant. Your job is to help the user with their tasks.
   subAgents:
     - name: web-search
-EOF
+' | kubectl apply -f -
 ```
 
 From here, let's create a task that uses the manager agent.
 
 ```bash
-cat <<EOF | kubectl apply -f -
+echo '
 apiVersion: acp.humanlayer.dev/v1alpha1
 kind: Task
 metadata:
@@ -962,7 +971,7 @@ spec:
   agentRef:
     name: manager
   userMessage: "what is the data at https://lotrapi.co/api/v1/characters/2?"
-EOF
+' | kubectl apply -f -
 ```
 
 While this is running, you can run the following a few times to see how the parent agent calls a `delegate` tool which then spawns a new task that uses the `web-fetch` agent
@@ -1065,7 +1074,8 @@ spec:
   # When an approvalContactChannel is specified,
   # all tools on this MCP server will wait for human approval prior executing.
   approvalContactChannel:
-    name: approval-channel' | kubectl apply -f -
+    name: approval-channel
+' | kubectl apply -f -
 ```
 
 Be sure you have an agent that references the above `MCPServer` by running `kubectl describe agent` or create a fresh `agent` with:
@@ -1081,7 +1091,8 @@ spec:
   system: |
     You are a helpful assistant. Your job is to help the user with their tasks.
   mcpServers:
-    - name: fetch' | kubectl apply -f -
+    - name: fetch
+' | kubectl apply -f -
 ```
 
 The fun part: Create a new task that uses the `fetch` tool to test the human approval workflow.
@@ -1094,7 +1105,8 @@ metadata:
 spec:
   agentRef:
     name: agent-with-fetch
-  userMessage: "Write me a haiku about the character found at https://swapi.dev/api/people/2?"' | kubectl apply -f -
+  userMessage: "Write me a haiku about the character found at https://swapi.dev/api/people/2?"
+' | kubectl apply -f -
 ```
 
 Once this hits the tool call, we can check out the tool calls to see the human approval workflow in action:
@@ -1178,7 +1190,8 @@ spec:
   email:
     address: "$MY_EMAIL"
     subject: "Request for Expertise" 
-    contextAboutUser: "A human expert that can provide a wide-range answers on a variety of topics"' | kubectl apply -f -
+    contextAboutUser: "A human expert that can provide a wide-range answers on a variety of topics"
+' | kubectl apply -f -
 ```
 
 Alright, we're ready for a brand new agent:
@@ -1196,7 +1209,8 @@ spec:
   mcpServers:
     - name: fetch
   humanContactChannels:
-    - name: human-expert' | kubectl apply -f -
+    - name: human-expert
+' | kubectl apply -f -
 ```
 
 Note the inclusion of `humanContactChannels` here, which now incorporates the `ContactChannel` we just made. Moving forward, any `Task` calls made against this `Agent` will attempt to make use of a human contact where appropriate. As an example, the following Task, _should_ (remember, "non-deterministic") reach out to our Luke Skywalker expert for more information before wrapping up the final output:
@@ -1209,7 +1223,8 @@ metadata:
 spec:
   agentRef:
     name: agent-with-human-tool
-  userMessage: "Ask an expert what the fastest animal on the planet is."' | kubectl apply -f -
+  userMessage: "Ask an expert what the fastest animal on the planet is."
+' | kubectl apply -f -
 ```
 
 Provided, you've setup your `ContactChannel` correctly, you should receive an email requesting your expertise. Feel free to respond when ready and keep an eye on how your `Task` and `ToolCall` statuses changes as the answer is picked up.

acp/config/manager/kustomization.yaml

@@ -5,5 +5,5 @@ apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 images:
 - name: controller
-  newName: example.com/acp
-  newTag: v0.0.1
+  newName: ghcr.io/humanlayer/agentcontrolplane
+  newTag: v0.6.1

acp/config/release/latest-crd.yaml

@@ -49,6 +49,11 @@ spec:
           spec:
             description: AgentSpec defines the desired state of Agent
             properties:
+              description:
+                description: |-
+                  Description is an optional description for an agent.
+                  If present, it's included in any "delegateToAgent" tool descriptions
+                type: string
               humanContactChannels:
                 description: HumanContactChannels is a list of ContactChannel resources
                   that can be used for human interactions
@@ -88,6 +93,22 @@ spec:
                   - name
                   type: object
                 type: array
+              subAgents:
+                description: |-
+                  SubAgents is a list of local object references to other Agents
+                  that can be delegated to as sub-agents.
+                items:
+                  description: LocalObjectReference contains enough information to
+                    locate the referenced resource in the same namespace
+                  properties:
+                    name:
+                      description: Name of the referent
+                      minLength: 1
+                      type: string
+                  required:
+                  - name
+                  type: object
+                type: array
               system:
                 description: System is the system prompt for the agent
                 minLength: 1
@@ -147,6 +168,18 @@ spec:
                   - name
                   type: object
                 type: array
+              validSubAgents:
+                description: ValidSubAgents is the list of sub-agents that were successfully
+                  validated
+                items:
+                  properties:
+                    name:
+                      description: Name of the sub-agent
+                      type: string
+                  required:
+                  - name
+                  type: object
+                type: array
             type: object
         type: object
     served: true
@@ -726,6 +759,9 @@ spec:
   scope: Namespaced
   versions:
   - additionalPrinterColumns:
+    - jsonPath: .spec.agentRef.name
+      name: Agent
+      type: string
     - jsonPath: .status.ready
       name: Ready
       type: boolean
@@ -793,13 +829,81 @@ spec:
                 required:
                 - name
                 type: object
+              contextWindow:
+                description: |-
+                  ContextWindow provides the initial conversation context when creating a Task.
+                  If provided, contextWindow will be used and userMessage must be empty.
+                  This will be copied to status.ContextWindow, which is the source of truth
+                  for the ongoing conversation.
+                items:
+                  description: Message represents a single message in the conversation
+                  properties:
+                    content:
+                      description: Content is the message content
+                      type: string
+                    name:
+                      description: Name is the name of the tool that was called
+                      type: string
+                    role:
+                      description: Role is the role of the message sender (system,
+                        user, assistant, tool)
+                      enum:
+                      - system
+                      - user
+                      - assistant
+                      - tool
+                      type: string
+                    toolCallId:
+                      description: ToolCallID is the unique identifier for this tool
+                        call
+                      type: string
+                    toolCalls:
+                      description: ToolCalls contains any tool calls requested by
+                        this message
+                      items:
+                        description: ToolCall represents a request to call a tool
+                        properties:
+                          function:
+                            description: Function contains the details of the function
+                              to call
+                            properties:
+                              arguments:
+                                description: Arguments contains the arguments to pass
+                                  to the function in JSON format
+                                type: string
+                              name:
+                                description: Name is the name of the function to call
+                                type: string
+                            required:
+                            - arguments
+                            - name
+                            type: object
+                          id:
+                            description: ID is the unique identifier for this tool
+                              call
+                            type: string
+                          type:
+                            description: Type indicates the type of tool call. Currently
+                              only "function" is supported.
+                            type: string
+                        required:
+                        - function
+                        - id
+                        - type
+                        type: object
+                      type: array
+                  required:
+                  - content
+                  - role
+                  type: object
+                type: array
               userMessage:
-                description: UserMessage is the message to send to the agent.
-                minLength: 1
+                description: |-
+                  UserMessage is the message to send to the agent.
+                  If provided, userMessage will be used and contextWindow must be empty.
                 type: string
             required:
             - agentRef
-            - userMessage
             type: object
           status:
             description: TaskStatus defines the observed state of Task