Any plan to release a official tool writing guide?

[timwu-ipevo]

Hi,

Thank you for your excellent work.

I have a few questions for clarification. From what I see, all tools in R2R are hardcoded in py/core/agent. While this approach is fine, an official guide would be helpful. I tried to infer some rules from the source code, but I'm not sure if my understanding is accurate.

Could you confirm if the following assumptions are correct?

• R2R tools operate only during the retrieval stage of the RAG process; tools cannot be defined for use after generation.
• A properly defined R2R tool can be used directly by the deep research agent without additional code.

It would be helpful if the tool-writing guide could cover:

• How user prompts are mapped to tool parameters
• How to control which dialog scenarios trigger a tool
• How to define tool outputs in a way that R2R accepts—for example, current code suggests outputs must be Pydantic models

[NolanTrem]

This is a great issue to raise. I will put some thoughts into how we can expose these better, and will make a complete user's guide/cookbook around this once it's ready.

[NolanTrem]

Cookbook here!

https://r2r-docs.sciphi.ai/cookbooks/custom-tools