docs(tools): add best practices guide for function tools #785
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8 tasks
Add comprehensive best practices guide covering: - File upload handling patterns (both uploaded files and file paths) - Type annotation requirements - Tool naming conventions - Docstring standards - Error handling patterns - Structured return values Addresses common pitfalls and provides examples for building robust function tools in ADK. Relocates content from google/adk-python#3193 as requested by @boyangsvl.
Add new best practices guide to mkdocs.yml navigation under 'Custom Tools > Function tools' section. Fixes mkdocs build warning about page not in nav configuration.
jpantsjoha
force-pushed
the
docs/file-upload-best-practices
branch
from
4410e3f to
48a18a8
Compare
|
Hi team! 👋 Just a friendly check-in on this PR. It's been about 5 days since submission and I wanted to see if there's anything I can adjust or clarify to help with the review process. Happy to make any changes needed. Thanks for your time reviewing community contributions! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds comprehensive best practices guide for building function tools in ADK, covering:
Context
This documentation was originally submitted to
google/adk-pythonin PR #3193 but has been relocated toadk-docsas requested by @boyangsvl for public-facing documentation.Location
docs/tools/best-practices.mdReferences
Testing