summaryrefslogtreecommitdiff
path: root/docs/core/tools-api.md
diff options
context:
space:
mode:
authorJosh Soref <[email protected]>2025-07-21 17:54:44 -0400
committerGitHub <[email protected]>2025-07-21 21:54:44 +0000
commitdc2ac144b7059ec2d66f1e90316df40d3822c8b5 (patch)
tree63c9bece313ae92c841ab2808253c9cc6eaee755 /docs/core/tools-api.md
parent8be5f8038a50fb5b2010590c8a18a4558da1663c (diff)
Various spelling improvements (#3497)
Signed-off-by: Josh Soref <[email protected]> Co-authored-by: Sandy Tao <[email protected]>
Diffstat (limited to 'docs/core/tools-api.md')
-rw-r--r--docs/core/tools-api.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/core/tools-api.md b/docs/core/tools-api.md
index 9a902129..e10333d2 100644
--- a/docs/core/tools-api.md
+++ b/docs/core/tools-api.md
@@ -8,7 +8,7 @@ The Gemini CLI core (`packages/core`) features a robust system for defining, reg
- `name`: A unique internal name (used in API calls to Gemini).
- `displayName`: A user-friendly name.
- `description`: A clear explanation of what the tool does, which is provided to the Gemini model.
- - `parameterSchema`: A JSON schema defining the parameters the tool accepts. This is crucial for the Gemini model to understand how to call the tool correctly.
+ - `parameterSchema`: A JSON schema defining the parameters that the tool accepts. This is crucial for the Gemini model to understand how to call the tool correctly.
- `validateToolParams()`: A method to validate incoming parameters.
- `getDescription()`: A method to provide a human-readable description of what the tool will do with specific parameters before execution.
- `shouldConfirmExecute()`: A method to determine if user confirmation is required before execution (e.g., for potentially destructive operations).