Bluwing/Docsv0.9.0
Operational
API ReferenceConsole

Get started

  • Introduction
  • Quickstart
  • How it works

Build

  • Tool format
  • Matching hints
  • Toolsets and builds
  • Versions and live

Call

  • Resolve a request
  • Reading responses
  • OpenAI and Anthropic compatibility

Account

  • Authentication
  • Credits and billing
  • Limits
  • Errors
  • Security and data
  • FAQ

Build

Matching hints

Other names, example requests, side effects and confirmation, on top of the standard tool format.

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.

json
{
  "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

FieldWhat it doesLimit
aliasesOther names people use for the tool.16
examplesReal requests that should pick this tool. The strongest hint there is.32
negative_examplesRequests that look close but belong to another tool.32
tagsGroups related tools.8
side_effectnone, read, write or destructive. Returned with every call.
requires_confirmationWhether 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 examples and to the wrong one's negative_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 wordSide effect
get, list, search, find, read, fetch, lookup, queryread
delete, remove, drop, destroy, purgedestructive
anything elsewrite

requires_confirmation defaults to true for destructive tools and false otherwise.

Heads up

These are labels for your code. Bluwing doesn't run tools, so it can't stop one from running. Check requires_confirmation before you call anything that spends money or deletes data.

PreviousTool formatNext Toolsets and builds

Something unclear or missing? Write to [email protected] and we'll fix the page.

On this page

  • The fields
  • When to add them
  • Side effects