Add reserved arg names to tools #1553
Merged
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
Contributor
|
Mintlify preview ID generated: preview-lauren-1763669459-851dbe8 |
hntrl
reviewed
Nov 20, 2025
src/oss/langchain/tools.mdx
Outdated
Comment on lines
141
to
160
|
|
||
| ### Reserved argument names | ||
|
|
||
| The following parameter names are reserved and cannot be used as tool arguments. Using these names will cause runtime errors. | ||
|
|
||
| :::python | ||
| | Parameter name | Purpose | | ||
| |----------------|---------| | ||
| | `config` | Reserved for passing `RunnableConfig` to tools internally | | ||
| | `runtime` | Reserved for `ToolRuntime` parameter (accessing state, context, store) | | ||
|
|
||
| To access runtime information, use the @[`ToolRuntime`] parameter instead of naming your own arguments `config` or `runtime`. | ||
| ::: | ||
|
|
||
| :::js | ||
| | Parameter name | Purpose | | ||
| |----------------|---------| | ||
| | `config` | Reserved for passing runtime context and configuration to tools | | ||
|
|
||
| To access runtime configuration, use the `config` parameter as the second argument to your tool function (not in the schema). |
Member
There was a problem hiding this comment.
think the term "reserved argument names" is much more applicable to python then it is to JS. Think it's fine if this is a python only section
Contributor
|
Mintlify preview ID generated: preview-lauren-1763673228-b580b4a |
sydney-runkle
approved these changes
Nov 20, 2025
lnhsingh
deleted the
lauren/doc-475-document-reserved-argument-names-for-tools
branch
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.
Fixes DOC-475