Skip to content

contrib: add tool_registry with AgenticSession support#417

Open
lex00 wants to merge 5 commits intotemporalio:mainfrom
lex00:feat/tool-registry
Open

contrib: add tool_registry with AgenticSession support#417
lex00 wants to merge 5 commits intotemporalio:mainfrom
lex00:feat/tool-registry

Conversation

@lex00
Copy link
Copy Markdown

@lex00 lex00 commented Apr 13, 2026

What was changed

New Temporalio::Contrib::ToolRegistry for running LLM tool-calling loops inside Temporal activities.

  • ToolRegistry — maps tool names to JSON Schema definitions and handler functions
  • run_tool_loop — standalone tool loop, no Temporal worker required
  • AgenticSession — crash-safe wrapper that checkpoints conversation history via Temporalio::Activity::Context#heartbeat on each turn and restores on retry; session survives both activity crashes and provider-side session expiry since state is stored locally
  • Built-in Anthropic and OpenAI providers
  • Testing::MockProvider for unit testing without a live API key
  • Registry.from_mcp_tools — converts a list of MCP tool descriptors into a populated registry

Bug fix included

The Anthropic provider now sets is_error: true on tool result entries when a handler raises, matching the Anthropic API spec. require 'anthropic' is now deferred to build_client so mock clients work without the gem installed. Tests for both behaviors are included. OpenAI has no equivalent field.

Why?

Temporal activities are a natural fit for LLM tool-calling loops, but every team reimplements the same boilerplate. This contrib module standardizes the pattern across all six Temporal SDKs. Ruby has no framework-level LLM integration (Python's openai_agents/google_adk_agents and TypeScript's @temporalio/ai-sdk are Python/TypeScript only), so this is the recommended path for direct Anthropic/OpenAI calls in Ruby.

Proposal: temporalio/proposals#107

Checklist

  1. Related to: Add ToolRegistry + AgenticSession proposal proposals#107
  2. How was this tested: unit tests with MockProvider and injected mock clients (no API key required); integration tests against live Anthropic and OpenAI APIs gated on RUN_INTEGRATION_TESTS=1 (skipped by default)
  3. Any docs updates needed? Yes — docs.temporal.io update to follow after merge

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@lex00 lex00 requested a review from a team as a code owner April 13, 2026 03:53
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Apr 13, 2026

CLA assistant check
All committers have signed the CLA.

lex00 and others added 4 commits April 12, 2026 22:40
Adds Registry.from_mcp_tools class method that converts a list of MCP tool
descriptors into a populated Registry. Handlers default to no-ops; callers
override with register after construction. Nil input_schema is normalized to
an empty object schema.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…ests

- Move 'require anthropic' into build_client so mock clients work without
  the anthropic gem installed
- Set is_error=true on Anthropic tool result entries when a handler raises,
  matching the Anthropic API spec; OpenAI has no equivalent field
- Add tests for handler error → is_error and no is_error on success, using
  an injected mock client (no real API key needed)
- Update README to clarify positioning vs Python/TypeScript framework plugins

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Rename @issues → @results, add_issue → add_result, attr_reader :issues → :results
- Update checkpoint JSON key 'issues' → 'results'
- Add ScheduleToCloseTimeout guidance to README
- Update all test references

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
The quickstart example used `issues` as the local collector variable, left
over from before the AgenticSession field was renamed to `results` in round 2.
Rename to `results` so the example is consistent with the other SDK READMEs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.

2 participants