Hints are optional extra facts about a tool. They sit next to function in an object called x-rednet. Models and SDKs ignore the key, so the same tool list still works everywhere else.
{
"type": "function",
"function": { "name": "book_table", "description": "Book a table at a restaurant.", "parameters": { "type": "object", "properties": {} } },
"x-rednet": {
"aliases": ["reserve a table", "get a reservation"],
"examples": ["Book Nok for four tomorrow at 7pm", "Table for two at Vinoteka on Friday"],
"negative_examples": ["Cancel my booking at Nok"],
"tags": ["dining"],
"side_effect": "write",
"requires_confirmation": false
}
}The fields
| Field | What it does | Limit |
|---|---|---|
aliases | Other names people use for the tool. | 16 |
examples | Real requests that should pick this tool. The strongest hint there is. | 32 |
negative_examples | Requests that look close but belong to another tool. | 32 |
tags | Groups related tools. | 8 |
side_effect | none, read, write or destructive. Returned with every call. | |
requires_confirmation | Whether your app should ask the user before running it. Returned with every call. |
Each phrase can be up to 1,024 characters.
When to add them
Start without hints. Add them when a request picks the wrong tool, or no tool:
- The request used a word the description doesn't: add it to
aliases. - Two tools are close and the wrong one wins: add the request to the right tool's
examplesand to the wrong one'snegative_examples.
Rebuilding with changed hints only charges for the tools that changed. See Versions and live.
Side effects
Every call in a response carries side_effect and requires_confirmation, so your code can decide what to run straight away and what to confirm first. When you don't set side_effect, it comes from the first word of the name:
| First word | Side effect |
|---|---|
get, list, search, find, read, fetch, lookup, query | read |
delete, remove, drop, destroy, purge | destructive |
| anything else | write |
requires_confirmation defaults to true for destructive tools and false otherwise.