Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tool Guide for documenting how to use tools across both AgentChat and Core #5649

Open
ekzhu opened this issue Feb 21, 2025 · 0 comments
Open
Labels
documentation Improvements or additions to documentation needs-triage proj-extensions
Milestone

Comments

@ekzhu
Copy link
Collaborator

ekzhu commented Feb 21, 2025

The guide should be in Extensions->Tool Guide. The guide should cover:

  1. FunctionTool:
  • How to define them as Python function (both sync and async)
  • How does it work: function gets inspected and automatically generates the JSON schema.
  • Recommendation on input parameter design: use simple and as few parameters as possible, avoid nested types like dictionaries.
  • Recommendation on return type: use serializable types to better integrate with models -- use string as much as possible.
  • Recommendation on type hinting and doc string
  1. Built-in Tools: a listing pointing to existing built in tools in the API doc.
  2. Custom BaseTool implementation:
  • An example to show how to create one.
  • Consideration for serializable configuration.

There are existing docs in AgentChat and Core mentioning tools:

We should move the main content from these docs that regards to tools specifically to the Tool Guide. Leave content regarding to using tools as part of agent.

@ekzhu ekzhu added documentation Improvements or additions to documentation proj-extensions labels Feb 21, 2025
@ekzhu ekzhu added this to the 0.4.x-python milestone Feb 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation needs-triage proj-extensions
Projects
None yet
Development

No branches or pull requests

1 participant