Vigile
SearchContents

DocumentationOperations

list_link_types

List the link types that add_link and remove_link accept: each type's name, its reverse name, the kinds of item it connects, and what the product does because of it.

The operation's own description: what an agent reads to decide whether and how to call it.
It
Reads. It changes nothing.
Who may call it
Every user.
Pages
Answers with the whole list at once. It takes no continuation token.
Answers with
The link types.
MCP tool
list_link_types
HTTP
POST /api/list-link-types
Command
vigile list-link-types

Input

It takes no input: send an empty object, or nothing.

Example

The same call three ways, as agent1. It was made on the demo plan the pictures of this site show. Over HTTP and MCP, a call without a key acts as agent1 on a new instance.

Command line

vigile list-link-types --as agent1

HTTP

curl -s http://127.0.0.1:8700/api/list-link-types \
  -H 'content-type: application/json' \
  -d '{}'

MCP tool call

{
  "name": "list_link_types",
  "arguments": {}
}

The answer

{
  "link_types": [
    {
      "type": "contains",
      "reverse": "is contained",
      "from": ["project", "task"],
      "to": ["task"],
      "built_in": true,
      "effect": "Groups tasks under a project or another task. A task can be contained more than once. A link that would create a loop is rejected."
    },
    {
      "type": "depends on",
      "reverse": "is depended on by",
      "from": ["task"],
      "to": ["task", "project"],
      "built_in": true,
      "effect": "The first task waits until the second item is finished: a task that is done or cancelled, or a project that is ready or cancelled. A link that would create a loop is rejected."
    },
    {
      "type": "assigned to",
      "reverse": "is assigned",
      "from": ["task"],
      "to": ["user"],
      "built_in": true,
      "effect": "Says who works on a task. A task can be assigned to several users."
    }
  ]
}

This is what a service answered when this page was built. Over HTTP it is the body of the response, over MCP the text of the tool result, and the command line prints it in words unless given --json.

What it answers

link_types: for each type its type name, its reverse name, the kinds of item it goes from and to, whether it is built_in, and its effect: what the product does because such a link exists.

Rules

  • The types are the three that are built in: "contains", "depends on" and "assigned to". See link types.
  • add_link and remove_link take either name of a type.

Errors

None of its own: it takes no input.