shipitagent

Tools · Documents and apps

describe_binding

Read-only

Return the methods and parameters of one binding in `env`. Call this before using a binding for the first time.

When to use: Before calling a binding you have not used yet, call `describe_binding` with its name to learn its methods and parameters. Do it once per binding per task — the answer does not change mid-run. You do not need this for a binding you have already described, and you do not need to describe every binding up front. Describe the one you are about to use.

Example

The call

tool call
{
  "tool": "describe_binding",
  "arguments": {
    "name": "orders"
  }
}

Needs a binding made with set_app_binding

So it isn't run here, and no output is shown: nothing on this page is made up.

Parameters

NameTypeDescription
name*stringBinding name as it appears in `env`, e.g. 'GITHUB'. Case-insensitive.

* required

Build documents, dashboards and small apps people can open.