Skip to content

Conversation

@Ju-usc
Copy link

@Ju-usc Ju-usc commented Oct 10, 2025

Summary

Addresses #8706 which requested GEPA to optimize tool descriptions.

When enable_tool_optimization=True, GEPA jointly optimizes:

  • ReAct modules: react instructions, extract instructions, tool descriptions, and tool argument descriptions
  • Generic tool-using predictors: predictor instructions, tool descriptions, and tool argument descriptions

All components are optimized together based on shared execution traces, enabling the reflection LM to see how components work together.

Backward compatible - enable_tool_optimization=False (default) preserves existing behavior.

Issue

Closes #8706

Changes

Core Implementation

  • enable_tool_optimization parameter on GEPA (default False)
  • Type-based detection: Identifies tool-using predictors via signature field annotations (dspy.Tool, list[dspy.Tool], dict[str, Tool])
  • Trace-based tool extraction: Discovers actual tools used at runtime from execution traces
  • ToolModuleProposer: Specialized proposer with dynamic signature generation for each tool and argument
  • ReAct handling: Discovers ReAct modules via isinstance() check, includes both react and extract predictors
  • Routing: Tool-using modules → ToolModuleProposer; regular predictors → default/custom proposer
  • Serialization: Tool modules stored as JSON configs with predictor instructions and tool schemas
  • Application: Applies optimized descriptions to dspy.Tool objects by matching tool.name

Testing

9 tests covering:

  • Single/multiple tool detection in custom modules
  • Skip predictors without tool annotations
  • Apply optimized tool descriptions via build_program
  • ReAct module detection (single, multiple, nested)
  • Apply optimized ReAct descriptions
  • Selective optimization when LM returns None

Documentation

  • GEPA_Advanced.md - Tool optimization guide with usage examples
  • overview.md - Brief introduction linking to advanced guide

Usage Example

ReAct Agent

import dspy

def search_web(query: str) -> str:
    return f"Search results for: {query}"

search_tool = dspy.Tool(search_web, name="search_web", desc="Search the web")

agent = dspy.ReAct("question -> answer", tools=[search_tool])

gepa = dspy.GEPA(
    metric=my_metric,
    reflection_lm=dspy.LM("openai/gpt-4o-mini"),
    enable_tool_optimization=True,
    auto="medium"
)

optimized = gepa.compile(agent, trainset=trainset, valset=valset)

Custom Tool-Using Predictor

import dspy

class AgentSignature(dspy.Signature):
    query: str = dspy.InputField()
    tools: list[dspy.Tool] = dspy.InputField()
    answer: str = dspy.OutputField()

class Agent(dspy.Module):
    def __init__(self):
        super().__init__()
        self.tools = [dspy.Tool(search_web, name="search", desc="Search tool")]
        self.pred = dspy.Predict(AgentSignature)

    def forward(self, query):
        return self.pred(query=query, tools=self.tools)

gepa = dspy.GEPA(
    metric=my_metric,
    reflection_lm=dspy.LM("openai/gpt-4o-mini"),
    enable_tool_optimization=True,
    auto="medium"
)

optimized = gepa.compile(Agent(), trainset=trainset, valset=valset)

Key Features

  • Joint Optimization: Predictor instructions and tool descriptions optimized together
  • Selective Updates: LM returns None for unchanged components
  • Multi-Agent Support: Discovers nested ReAct modules and tool-using predictors

Ju-usc added 3 commits October 9, 2025 20:07
- Add optimize_tool_descriptions parameter (default False) to GEPA
- Extract tool descriptions from all nested modules via named_sub_modules()
- Apply optimized descriptions in DspyAdapter.build_program()
- Enables holistic optimization of tools across main and subagent modules
- Tests: 4 new tests, all 16 pass (4 new + 12 existing)
@Ju-usc
Copy link
Author

Ju-usc commented Oct 10, 2025

Apologies for accidentally closing #8927

Thank you for the thorough review, @LakshyAAAgrawal! I'll address your feedback:

  1. Since tools are categorically different from prompts, they should use a different reflection meta prompt. The default reflection meta prompt is shown here https://dspy.ai/api/optimizers/GEPA/GEPA_Advanced/#default-implementation, whereas I assume that the tool must use somewhat different meta prompt. Can you implement a propose_new_texts method that mimics the default_proposer shown in the link above for all prompts, but calls to a tool description specific prompt/signature for tool evolution.
  2. Can you also add some description to the documentation, explaining that this feature is beneficial for React agents.
  3. (This is not a requirement to merge the PR) Would it be possible to add a simple and short tutorial demonstrating the use and performance improvement via tool evolution?

I'll start working on items 1 and 2 and update the PR soon. Please let me know if you have any specific preferences for the tutorial format!

@LakshyAAAgrawal
Copy link
Collaborator

Thanks a lot! For the tutorial, I think you can follow the current GEPA tutorial format (load a dataset, show an example from the dataset, build a dspy program, evaluate the baseline program on testset, run GEPA with new optimization settings, show the optimized programs' prompts and tool descriptions, and finally evaluate the optimized program).

Hopefully we should be able to see a nice and large gain on agentic tasks with this amazing contribution by you!

- Add ToolProposer with GenerateImprovedToolDescription signature
- Implement routing logic to separate tools from signatures
- Tools use ToolProposer, signatures use custom or parent default
- Backward compatible: preserves existing custom_instruction_proposer behavior
- Add test verifying routing splits components correctly
- Define tool functions outside class for clarity
- Match structure of simple ReAct example
- Add clear comments explaining architecture
- Make code more readable and maintainable
@Ju-usc Ju-usc force-pushed the feature/tool-description-optimization branch from 197f077 to c4f2041 Compare October 10, 2025 09:38
@Ju-usc
Copy link
Author

Ju-usc commented Oct 10, 2025

Hi @LakshyAAAgrawal,

I've implemented the tool-specific proposer as requested! Here's what's included:

1. Tool-Specific Proposer Implementation

  • Added GenerateImprovedToolDescriptionFromFeedback signature with a specialized reflection prompt
  • Implemented ToolProposer and SingleComponentToolProposer following the MultiModalInstructionProposer pattern
  • Routing logic in DspyAdapter that directs tools to ToolProposer and signatures to custom/default proposers
  • Fully backward compatible with existing custom instruction proposers

2. Documentation

  • Added comprehensive section to GEPA_Advanced.md
  • Explains when to use tool optimization (ReAct agents, multi-agent systems)
  • Includes usage examples for both simple and nested agent architectures
  • Documents how to inspect optimized tool descriptions

Reflection Prompt Design:
The tool-specific prompt is intentionally open-ended to avoid prescriptive patterns that might lead to local minima. It asks the LM to identify patterns in successful/unsuccessful tool usage and extract domain-specific information, without suggesting specific heuristics.

Before I create a short tutorial (item #3), would you have any feedback on:

  • The reflection prompt design - is it general enough? Any improvements you'd suggest?
  • The implementation approach - does the routing logic make sense?
  • The documentation - anything unclear or missing?

Any feedback would be helpful before I invest time in the tutorial. Thank you!

@Ju-usc
Copy link
Author

Ju-usc commented Oct 11, 2025

wait there is a bug in the implementation working on it to fix. Also test has to be fixed.

…euse

Tools now copy ReAct's reflective data with tool-specific annotation
instead of complex trajectory extraction. This 15-line approach reuses
ReAct's existing context (thoughts, tool calls, observations) and adds
focused annotation for each tool.

Implementation:
- Tools receive full ReAct reflective examples (same trajectory context)
- Feedback prefixed: [Optimizing tool: 'X'] for focused optimization
- Reflection LM sees complete multi-step execution traces per tool

Benefits:
- Simpler: 15 lines vs 70+ line extraction approach
- Reuses code: No duplicate trajectory formatting logic
- Same context: Tools see full ReAct execution traces
- Clean: Removed all debug output

Tests:
- 4 focused tests following GEPA patterns (removed 1 redundant)
- 226KB fixture with 34 LM + 6 reflection calls
- All tests passing with gpt-5-nano traces

Documentation:
- Updated GEPA_Advanced.md with implementation details
- Explains reflective dataset construction approach

The `optimize_tool_descriptions` parameter enables GEPA to optimize tool descriptions in addition to signature instructions. This is particularly valuable for ReAct agents and other tool-using systems, where the quality of tool descriptions directly impacts the agent's ability to select appropriate tools for each task.

Unlike signature instructions that guide reasoning strategies, tool descriptions serve a fundamentally different purpose: they help agents decide **which tool to use** in a given situation. GEPA recognizes this categorical difference and applies a specialized reflection prompt tailored for tool selection decisions.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which tool to use, when to use it, and how to use it. All three are captured by the description.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's avoid the word "fundamentally". One can imagine that all of tool descriptions can (and many times do) simply included in the system prompt itself.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please also add a corresponding entry in GEPA Overview, that links to this file/section.


Consider enabling `optimize_tool_descriptions=True` when:

- **Building ReAct agents**: ReAct agents rely on tool descriptions to make action selection decisions
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One should consider using this, when they use dspy.Tool anywhere in the DSPy program. Here are a few scenarios for using dspy.Tool:

)
```

**Note:** Tool optimization is fully backward compatible. Existing programs without tools, or with `optimize_tool_descriptions=False`, continue to work exactly as before.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need to inform users about backward compatibility here. It should be implicit that there should be no behaviour changes for any program not containing dspy.Tool.

raised if a mismatch in module-level and predictor-level score is detected.
optimize_tool_descriptions: Whether to optimize tool descriptions for modules with tools
(e.g., ReAct agents). When enabled, tool descriptions are included in the optimization
process alongside signature instructions. Default is False.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a link to GEPA Advanced/Tool section

)

self.propose_new_texts = custom_propose_new_texts
elif self.optimize_tool_descriptions:
Copy link
Collaborator

@LakshyAAAgrawal LakshyAAAgrawal Oct 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Edge case: What should happen when user tries to provide both a custom proposer, and enables optimize_tool_descriptions

# Handle signature components - replicate proposer's default behavior
sig_texts = {}
if sig_components:
from gepa.strategies.instruction_proposal import InstructionProposalSignature
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a slight deviation from this PR, but would be a large enhancement (feel free to ignore):

  1. Create 2 fields, self.instruction_proposal_signature and self.tool_proposer, which are initialized to the default InstructionProposalSignature and ToolProposerSignature.
  2. Take an argument from dspy.GEPA that can override the default signature values.

# Second pass: Process tools by copying ReAct data with annotation
react_module_name = None
for name in ret_d.keys():
if "react" in name.lower():
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this robust? Might it be better to use isinstance or some other way?

Your task is to write a better description for this tool.
Read the examples carefully and identify patterns in when the tool was used successfully versus when it was misused or overlooked. Identify any domain-specific information about the tool's capabilities or appropriate usage that may not be available to the assistant in the future. The assistant may have developed effective patterns for tool selection - if so, ensure the tool description supports those patterns.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tool use. Also suggest identifying any failure modes of the tool?

@LakshyAAAgrawal
Copy link
Collaborator

Dear @Ju-usc,

This is a great PR. Thanks a lot! I have tried to be overly critical and made too many nits. Feel free to ignore if you disagree with something. Let me know if you'd like me to address anything!

Regarding the meta prompt, overall I think it looks great. However, I suggest that as you build the tutorial, you may find that the reflection prompt needs tweaking, or the content exposed in reflective_dataset for the tool may be lacking or need improvement. This is going to be an empirical exercise, which will guide what works in the reflection meta prompts. ! Looking forward to the tutorial on this too!

You may already have thoughts about what you'd like to show in the tutorial, but if not, you may consider building off (https://kargarisaac.medium.com/building-and-optimizing-multi-agent-rag-systems-with-dspy-and-gepa-2b88b5838ce2) by @kargarisaac.

- Add GenerateImprovedToolDescriptionFromFeedback signature documentation
- Include tool-aware metric example showing trajectory access
- Document tool prefix annotation in feedback
- Note component_selector applies to both signatures and tools
- Fix 'fundamentally' language per reviewer feedback
- Separate Pass 1 (predictor examples) and Pass 2 (tool aggregation)
- Clarify Generated Outputs includes full trajectory for ReAct
- Fix feedback annotation format to [Tool 'name' from 'predictor_key']
- Add Component Identification & Proposer Routing section
- Explain dual-proposer independence (custom proposer doesn't affect tool proposer)
- Use consistent terminology: 'predictor' and 'signature instructions'
Improve instructions for the reflection LM to focus on reinforcing successful patterns and providing progressively optimized updates for predictor instructions and tool descriptions.
Move tool extraction logic to evaluate() loop for immediate capture. Fix overwrite risk by merging discovered tools with existing config. Improve logging and docstrings for better maintainability.
Move helper function outside loop and simplify predictor deduplication check by validating keys before parsing JSON.
Use standard trace selection logic (prioritizing failures) for all modules including ReAct. The extractor logic workaround is no longer needed as we handle aggregated duplicates differently.
@Ju-usc Ju-usc force-pushed the feature/tool-description-optimization branch 2 times, most recently from 7b95f13 to 86a885a Compare November 19, 2025 07:08
@Ju-usc Ju-usc force-pushed the feature/tool-description-optimization branch 2 times, most recently from 72f5ecb to deeb010 Compare November 19, 2025 07:40
@Ju-usc
Copy link
Author

Ju-usc commented Nov 20, 2025

@LakshyAAAgrawal @chenmoneygithub

Thanks again for the thoughtful feedback — I've pushed toward as generic as safely possible while preserving ReAct behavior.

Core idea: Optimize tools jointly with the predictor that uses them.

For generic tool modules, I detect predictors with dspy.Tool in their signature at compile time, then discover actual tools from traces at runtime. For ReAct, we know tools statically from module.tools. Both share the same ToolModuleProposer and update path — the only difference is when tools are discovered.

Here are my thoughts on a few design choices. Feel free to comment on these or anything else:

  1. Prefix-based grouping (react_module: / tool_module:) — I encode module type in string keys to preserve GEPA's dict[str, str] interface. A bit hacky, but avoids changing the core adapter API.

  2. ReAct tracing uses extract only — The extract predictor's trace already contains the full trajectory, so this avoids the duplicated-prefix issue from Reflective dataset contains potentially redundant data for ReAct agent gepa-ai/gepa#97.

  3. No separate tool tracing yet — Reflective dataset uses predictor-level traces only. Tool inputs are always captured (since dspy.Tool objects flow through predictor inputs), but tool outputs depend on how users design their module. If users need tool outputs in the reflective dataset, they can wire them back into a predictor. Is this enough for now, or should tool calls go into dspy.settings.trace?

  4. ReAct still has special handling — Because it has 2 predictors (react + extract) that need joint optimization. Is this acceptable given the maintenance blackhole concern, or should I push for fully generic?

Ran an experiment with nested ReAct + custom tool module: https://gist.github.com/Ju-usc/80b9918fe07288204579df735e084cb4

Happy to iterate!

Copilot finished reviewing on behalf of Ju-usc November 29, 2025 07:27
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

current_module_config = json.loads(candidate[module_key])

# Predictor keys: 1 for tool modules, 2 for ReAct modules (extra extract predictor)
predictor_keys = [k for k, v in current_module_config.items() if isinstance(v, str)]
Copy link

Copilot AI Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Potential IndexError if predictor_keys is empty. Add validation to ensure at least one predictor key exists before accessing index 0. Consider: if not predictor_keys: logger.warning(...); continue or raising a more descriptive error.

Suggested change
predictor_keys = [k for k, v in current_module_config.items() if isinstance(v, str)]
predictor_keys = [k for k, v in current_module_config.items() if isinstance(v, str)]
if not predictor_keys:
logger.warning(f"No predictor keys found for module '{module_key}'. Skipping.")
continue

Copilot uses AI. Check for mistakes.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is needed - config is built internally by GEPA and always contains predictor keys. Edge case seems impossible.

Comment on lines +460 to +472
for tool_name, tool_info in current_tools_dict.items():
# Update tool description if LM proposed a change
improved_tool_desc = getattr(result, f"improved_tool_{tool_name}_desc", None)
if improved_tool_desc is not None:
tool_info["desc"] = improved_tool_desc

# Update arg descriptions if LM proposed changes
for arg_name in tool_info["args"].keys():
improved_tool_arg_desc = getattr(result, f"improved_tool_{tool_name}_arg_{arg_name}_desc", None)
if improved_tool_arg_desc is not None:
tool_info["args"][arg_name]["description"] = improved_tool_arg_desc

improved_module_config["tools"][tool_name] = tool_info
Copy link

Copilot AI Nov 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mutating the input data structure. tool_info is a reference to a dict in current_tools_dict (from line 460), so modifications on lines 464 and 470 mutate the original candidate data. This can cause unintended side effects across GEPA iterations. Create a deep copy: import copy and tool_info = copy.deepcopy(tool_info) after line 460.

Copilot uses AI. Check for mistakes.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is an issue - candidate[module_key] is a json string, so json.loads() creates a new dict. Mutations don't affect the original.

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.

[Feature] Allow GEPA to update tool descriptions and tool error responses

3 participants