Tools

Orientation

Find out who is connected and which projects that account can read.

These two tools take no arguments and read nothing from your projects. They answer from the account the credential belongs to, which makes them the natural first call in a conversation.

whoami

Who you are signed in as, and which enterprises, organizations and projects you can read.

Call it first when the question does not name a project, or to confirm that the right account is connected.

Arguments: none.

userobject

Your user id and email.

countsobject

How many enterprises, organizations and projects you can reach.

projectsobject[]

One entry per project, with its slug, your access_type (full or partial), and restricted_by_role, which is true when your role grants only part of the project.

organizationsstring[]

The slugs of the organizations you belong to.

enterprisesstring[]

The slugs of the enterprises you belong to.

Example result

{
  "user": { "id": "3f1c2a90-…", "email": "you@example.com" },
  "counts": { "enterprises": 0, "organizations": 1, "projects": 2 },
  "projects": [
    { "slug": "acme-store", "access_type": "full", "restricted_by_role": false },
    { "slug": "acme-support", "access_type": "full", "restricted_by_role": true }
  ],
  "organizations": ["acme"],
  "enterprises": []
}

list_projects

The projects you can read, with the slug every other tool expects.

Use it when a question names a project the assistant has not seen yet, or to check whether you can reach a project at all. Returns up to 100 projects.

Arguments: none.

dataobject[]

One entry per project.

data[].slugstring

The project slug to pass as project_slug.

data[].access_typestring

full or partial.

data[].custom_accessboolean

true when your role grants only part of the project.

data[].viastring

Where the access comes from: project, organization or enterprise.

Example result

{
  "data": [
    { "id": 12, "slug": "acme-store", "access_type": "full", "custom_access": false, "via": "organization" },
    { "id": 19, "slug": "acme-support", "access_type": "full", "custom_access": true, "via": "project" }
  ],
  "_meta": { "returned": 2, "available": 2 }
}

A project reached both through an organization and directly is listed once.