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

docs: update context docs #555

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

cjellick
Copy link
Contributor

Signed-off-by: Craig Jellick [email protected]

cjellick added 2 commits June 25, 2024 14:44
Signed-off-by: Craig Jellick <[email protected]>
Signed-off-by: Craig Jellick <[email protected]>

## Context Provider Tool with args
## Context Provider Tool with Args
Copy link
Member

Choose a reason for hiding this comment

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

Is the official verbiage "Args" or "Params"?


The above example context tool has several interesting features:

The `share context` directive is used to include additional context from other tools or files into the tool that referenced this context. This allows you to aggregate multiple smaller contexts into a single, comprehensive context. Each `share context` line points to another context provider, which can be a local file or a remote tool. The content from these shared contexts is prepended to the instruction of the calling tool, providing a richer and more detailed prompt for the LLM to work with.
Copy link
Member

Choose a reason for hiding this comment

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

We call preamble fields "directives" here and "tool parameters" elsewhere. Is it worth standardizing the verbiage across the docs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Would be nice to standardize...ive also used the word stanza. "directive" here was actually a new one generated by gpt 😅

I do not like tool parameters because parameter is one of the parameters.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

im actually going to be adding more commits to this with other changes (with the goal of standardizing some other stuff).

Copy link
Member

Choose a reason for hiding this comment

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

I do not like tool parameters because parameter is one of the parameters

hard concur

im actually going to be adding more commits to this with other changes (with the goal of standardizing some other stuff)

sweet, thanks

Copy link
Member

Choose a reason for hiding this comment

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

Just to throw my vote in the hat, I think "tool field", "tool preamble field", or "tool definition field" are some descriptive options that are different enough from "tool parameters" to prevent confusion.

@cjellick cjellick marked this pull request as draft August 6, 2024 13:18
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.

2 participants