Skip to content

docs: clarify function node registration in execution paths#5508

Open
kostasuser01gr wants to merge 1 commit intoaden-hive:mainfrom
kostasuser01gr:docs/4725-clarify-executor
Open

docs: clarify function node registration in execution paths#5508
kostasuser01gr wants to merge 1 commit intoaden-hive:mainfrom
kostasuser01gr:docs/4725-clarify-executor

Conversation

@kostasuser01gr
Copy link

Summary

  • Addresses #4725
  • Clarifies that exported agents containing function nodes need to use the GraphExecutor path in agent.py to register them before execution.

Root Cause

  • The create_agent_runtime() path does not expose a way to register function implementations, leaving users confused about how to hook up custom Python functions when running agents via hive run or hive tui.

Solution

  • Added a new subsection titled Agents with Function Nodes under the ## Running an Agent section in both README.md and docs/getting-started.md.
  • Provided the recommended 3-step pattern (GraphExecutor(...) -> register_function() -> execute()).
  • Added a reference to the examples/templates/ directory for reference implementations.

Validation

  • Local Markdown format checked.
  • Verified correct linking and rendering locally.

Fixes #4725

Added a dedicated sub-section to 'Running an Agent' in both
the root README.md and docs/getting-started.md to clarify that
agents with function nodes must use the GraphExecutor path
for registration.

Refs aden-hive#4725
@kostasuser01gr kostasuser01gr marked this pull request as ready for review February 28, 2026 07:29
@kostasuser01gr
Copy link
Author

Ready for review. All checks passing. 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Clarify execution path for exported agents that use function nodes

1 participant