docs: extend tools docs #170
Merged
Conversation
This file contains 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
chr-hertel
force-pushed
the
docs-tools
branch
from
768fe48 to
20b8a5c
Compare
OskarStark
reviewed
Dec 21, 2024
| method arguments and param comments in the doc block. Additionally, JSON Schema support validation rules, which are | ||
| partially support by LLMs like GPT. | ||
|
|
||
| To leverage this, configure the `#[ToolParameter]` attribute on the method arguments of your tool: |
There was a problem hiding this comment.
Maybe add a link to the class ToolParameter?
Offtopic, but maybe it's more fail safe to have sth like "#[Minimum]" etc as we can then validate it is only used for integers for example 🤔 to avoid god classes
There was a problem hiding this comment.
added a comment below the example code to link to the attribute class, good idea 👍
i do get the intention in resolving the mega attribute class, but on the other hand it would make it harder to parse that thing in ParameterAnalyzer
OskarStark
approved these changes
Dec 21, 2024
chr-hertel
force-pushed
the
docs-tools
branch
from
20b8a5c to
9845af4
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.