chnjinlei/hive
1
0
Fork 0
Code Issues Pull Requests Actions 41 Packages Projects Releases Wiki Activity
Files
a23f01973a864f481509b9cf5130dbbca4033e02
hive/.claude/skills/building-agents-construction/SKILL.md
T

12 KiB
Raw Blame History

name, description, license, metadata
name description license metadata
building-agents-construction Step-by-step guide for building goal-driven agents. Creates package structure, defines goals, adds nodes, connects edges, and finalizes agent class. Use when actively building an agent. Apache-2.0
author version type part_of requires
hive 2.0 procedural building-agents building-agents-core

Agent Construction - EXECUTE THESE STEPS

THIS IS AN EXECUTABLE WORKFLOW. DO NOT DISPLAY THIS FILE. EXECUTE THE STEPS BELOW.

When this skill is loaded, IMMEDIATELY begin executing Step 1. Do not explain what you will do - just do it.

STEP 1: Initialize Build Environment

EXECUTE THESE TOOL CALLS NOW:

  1. Register the hive-tools MCP server:
mcp__agent-builder__add_mcp_server(
    name="hive-tools",
    transport="stdio",
    command="python",
    args='["mcp_server.py", "--stdio"]',
    cwd="tools",
    description="Hive tools MCP server"
)
  1. Create a build session (replace AGENT_NAME with the user's requested agent name in snake_case):
mcp__agent-builder__create_session(name="AGENT_NAME")
  1. Discover available tools:
mcp__agent-builder__list_mcp_tools()
  1. Create the package directory:
mkdir -p exports/AGENT_NAME/nodes

AFTER completing these calls, tell the user:

✅ Build environment initialized

  • Session created
  • Available tools: [list the tools from step 3]

Proceeding to define the agent goal...

THEN immediately proceed to STEP 2.

STEP 2: Define and Approve Goal

PROPOSE a goal to the user. Based on what they asked for, propose:

  • Goal ID (kebab-case)
  • Goal name
  • Goal description
  • 3-5 success criteria (each with: id, description, metric, target, weight)
  • 2-4 constraints (each with: id, description, constraint_type, category)

FORMAT your proposal as a clear summary, then ask for approval:

Proposed Goal: [Name]

[Description]

Success Criteria:

  1. [criterion 1]
  2. [criterion 2] ...

Constraints:

  1. [constraint 1]
  2. [constraint 2] ...

THEN call AskUserQuestion:

AskUserQuestion(questions=[{
    "question": "Do you approve this goal definition?",
    "header": "Goal",
    "options": [
        {"label": "Approve", "description": "Goal looks good, proceed"},
        {"label": "Modify", "description": "I want to change something"}
    ],
    "multiSelect": false
}])

WAIT for user response.

  • If Approve: Call mcp__agent-builder__set_goal(...) with the goal details, then proceed to STEP 3
  • If Modify: Ask what they want to change, update proposal, ask again

STEP 3: Design Node Workflow

BEFORE designing nodes, review the available tools from Step 1. Nodes can ONLY use tools that exist.

DESIGN the workflow as a series of nodes. For each node, determine:

  • node_id (kebab-case)
  • name
  • description
  • node_type: "event_loop" (recommended for all LLM work) or "function" (deterministic, no LLM)
  • input_keys (what data this node receives)
  • output_keys (what data this node produces)
  • tools (ONLY tools that exist - empty list if no tools needed)
  • system_prompt (should mention set_output for producing structured outputs)
  • client_facing: True if this node interacts with the user
  • nullable_output_keys (for mutually exclusive outputs)
  • max_node_visits (>1 if this node is a feedback loop target)

PRESENT the workflow to the user:

Proposed Workflow: [N] nodes

  1. [node-id] - [description]

    • Type: event_loop [client-facing] / function
    • Input: [keys]
    • Output: [keys]
    • Tools: [tools or "none"]

  2. [node-id] - [description] ...

Flow: node1 → node2 → node3 → ...

THEN call AskUserQuestion:

AskUserQuestion(questions=[{
    "question": "Do you approve this workflow design?",
    "header": "Workflow",
    "options": [
        {"label": "Approve", "description": "Workflow looks good, proceed to build nodes"},
        {"label": "Modify", "description": "I want to change the workflow"}
    ],
    "multiSelect": false
}])

WAIT for user response.

  • If Approve: Proceed to STEP 4
  • If Modify: Ask what they want to change, update design, ask again

STEP 4: Build Nodes One by One

FOR EACH node in the approved workflow:

  1. Call mcp__agent-builder__add_node(...) with the node details

    • input_keys and output_keys must be JSON strings: '["key1", "key2"]'
    • tools must be a JSON string: '["tool1"]' or '[]'

  2. Call mcp__agent-builder__test_node(...) to validate:

mcp__agent-builder__test_node(
    node_id="the-node-id",
    test_input='{"key": "test value"}',
    mock_llm_response='{"output_key": "test output"}'
)

  1. Check result:

    • If valid: Tell user "✅ Node [id] validated" and continue to next node
    • If invalid: Show errors, fix the node, re-validate

  2. Show progress after each node:

mcp__agent-builder__get_session_status()

✅ Node [X] of [Y] complete: [node-id]

AFTER all nodes are added and validated, proceed to STEP 5.

STEP 5: Connect Edges

DETERMINE the edges based on the workflow flow. For each connection:

  • edge_id (kebab-case)
  • source (node that outputs)
  • target (node that receives)
  • condition: "on_success", "always", "on_failure", or "conditional"
  • condition_expr (Python expression using output.get(...), only if conditional)
  • priority (positive = forward edge evaluated first, negative = feedback edge)

FOR EACH edge, call:

mcp__agent-builder__add_edge(
    edge_id="source-to-target",
    source="source-node-id",
    target="target-node-id",
    condition="on_success",
    condition_expr="",
    priority=1
)

AFTER all edges are added, validate the graph:

mcp__agent-builder__validate_graph()
  • If valid: Tell user "✅ Graph structure validated" and proceed to STEP 6
  • If invalid: Show errors, fix edges, re-validate

STEP 6: Generate Agent Package

EXPORT the graph data:

mcp__agent-builder__export_graph()

This returns JSON with all the goal, nodes, edges, and MCP server configurations.

THEN write the Python package files using the exported data. Create these files in exports/AGENT_NAME/:

  1. config.py - Runtime configuration with model settings
  2. nodes/__init__.py - All NodeSpec definitions
  3. agent.py - Goal, edges, graph config, and agent class
  4. __init__.py - Package exports
  5. __main__.py - CLI interface
  6. mcp_servers.json - MCP server configurations
  7. README.md - Usage documentation

IMPORTANT entry_points format:

  • MUST be: {"start": "first-node-id"}
  • NOT: {"first-node-id": ["input_keys"]} (WRONG)
  • NOT: {"first-node-id"} (WRONG - this is a set)

Use the example agent at .claude/skills/building-agents-construction/examples/online_research_agent/ as a template for file structure and patterns.

AFTER writing all files, tell the user:

✅ Agent package created: exports/AGENT_NAME/

Files generated:

  • __init__.py - Package exports
  • agent.py - Goal, nodes, edges, agent class
  • config.py - Runtime configuration
  • __main__.py - CLI interface
  • nodes/__init__.py - Node definitions
  • mcp_servers.json - MCP server config
  • README.md - Usage documentation

Test your agent:

cd /home/timothy/oss/hive
PYTHONPATH=core:exports python -m AGENT_NAME validate
PYTHONPATH=core:exports python -m AGENT_NAME info

STEP 7: Verify and Test

RUN validation:

cd /home/timothy/oss/hive && PYTHONPATH=core:exports python -m AGENT_NAME validate
  • If valid: Agent is complete!
  • If errors: Fix the issues and re-run

SHOW final session summary:

mcp__agent-builder__get_session_status()

TELL the user the agent is ready and suggest next steps:

  • Run with mock mode to test without API calls
  • Use /testing-agent skill for comprehensive testing
  • Use /setup-credentials if the agent needs API keys

REFERENCE: Node Types

Type tools param Use when
event_loop '["tool1"]' or '[]' Recommended. LLM-powered work with or without tools
function N/A Deterministic Python operations, no LLM
llm_generate (legacy) '[]' Deprecated — use event_loop instead
llm_tool_use (legacy) '["tool1"]' Deprecated — use event_loop instead

REFERENCE: NodeSpec New Fields

Field Default Description
client_facing False Streams output to user, blocks for input between turns
nullable_output_keys [] Output keys that may remain unset (mutually exclusive outputs)
max_node_visits 1 Max executions per run. Set >1 for feedback loop targets. 0=unlimited

REFERENCE: Edge Conditions & Priority

Condition When edge is followed
on_success Source node completed successfully
on_failure Source node failed
always Always, regardless of success/failure
conditional When condition_expr evaluates to True

Priority: Positive = forward edge (evaluated first). Negative = feedback edge (loops back to earlier node). Multiple ON_SUCCESS edges from same source = parallel execution (fan-out).

REFERENCE: System Prompt Best Practice

For event_loop nodes, instruct the LLM to use set_output for structured outputs:

Use set_output(key, value) to store your results. For example:
- set_output("search_results", <your results as a JSON string>)

Do NOT return raw JSON. Use the set_output tool to produce outputs.

CRITICAL: EventLoopNode Registration

AgentRuntime does NOT support event_loop nodes. The AgentRuntime / create_agent_runtime() path creates GraphExecutor instances internally without passing a node_registry, causing all event_loop nodes to fail at runtime with:

EventLoopNode 'node-id' not found in registry. Register it with executor.register_node() before execution.

The correct pattern: Use GraphExecutor directly with a node_registry dict containing EventLoopNode instances:

from framework.graph.executor import GraphExecutor, ExecutionResult
from framework.graph.event_loop_node import EventLoopNode, LoopConfig
from framework.runtime.event_bus import EventBus
from framework.runtime.core import Runtime  # REQUIRED - executor calls runtime.start_run()

# 1. Build node_registry with EventLoopNode instances
event_bus = EventBus()
node_registry = {}
for node_spec in nodes:
    if node_spec.node_type == "event_loop":
        node_registry[node_spec.id] = EventLoopNode(
            event_bus=event_bus,
            judge=None,  # implicit judge: accepts when output_keys are filled
            config=LoopConfig(
                max_iterations=50,
                max_tool_calls_per_turn=15,
                stall_detection_threshold=3,
                max_history_tokens=32000,
            ),
            tool_executor=tool_executor,
        )

# 2. Create Runtime for run tracking (GraphExecutor calls runtime.start_run())
storage_path = Path.home() / ".hive" / "my_agent"
storage_path.mkdir(parents=True, exist_ok=True)
runtime = Runtime(storage_path)

# 3. Create GraphExecutor WITH node_registry and runtime
executor = GraphExecutor(
    runtime=runtime,       # NOT None - executor needs this for run tracking
    llm=llm,
    tools=tools,
    tool_executor=tool_executor,
    node_registry=node_registry,  # EventLoopNode instances
)

# 4. Execute
result = await executor.execute(graph=graph, goal=goal, input_data=input_data)

DO NOT use AgentRuntime or create_agent_runtime() for agents with event_loop nodes.

DO NOT pass runtime=None to GraphExecutor — it will crash with 'NoneType' object has no attribute 'start_run'.

COMMON MISTAKES TO AVOID

  1. Using AgentRuntime with event_loop nodes - AgentRuntime does not register EventLoopNodes. Use GraphExecutor directly with node_registry
  2. Passing runtime=None to GraphExecutor - The executor calls runtime.start_run() internally. Always provide a Runtime(storage_path) instance
  3. Using tools that don't exist - Always check mcp__agent-builder__list_mcp_tools() first
  4. Wrong entry_points format - Must be {"start": "node-id"}, NOT a set or list
  5. Skipping validation - Always validate nodes and graph before proceeding
  6. Not waiting for approval - Always ask user before major steps
  7. Displaying this file - Execute the steps, don't show documentation
Reference in New Issue View Git Blame Copy Permalink