List Agreements

tools/call list_agreements

Lists accessible agreements with optional search and pagination.

Conventions

Authentication

All endpoints require a Bearer token. Pass it in the Authorization header as Bearer <token>. Tokens are issued from the API settings page in your workspace.

Base URL

All paths are relative to https://mcp.allsign.app. The spec includes full paths; strip the base when constructing requests.

Versioning

The current version is 0.1.0. Breaking changes are documented in the Changelog and announced before taking effect.

Specification

The server follows the MCP specification and communicates via JSON-RPC 2.0. All documentation on this page is generated directly from the spec.

Example

Bash

curl "https://mcp.allsign.app" \
  -X POST \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_agreements",
    "arguments": {}
  }
}'

Request

Request Body

{
  "page": 1,
  "page_size": 1,
  "search": ""
}

page

Result page number.

integeroptional

page_size

Result page size.

integeroptional

search

Optional agreement search string.

stringoptional

Responses

200 OK

{
  "agreements": [],
  "page": 1,
  "page_size": 1,
  "total_pages": 1,
  "total_records": 1
}

agreements

object[]required

agreements[].description

stringrequired

agreements[].intent

stringrequired

agreements[].name

stringrequired

agreements[].ref

Public stable resource reference.

string (uuid)required

agreements[].status

stringrequired

page

integerrequired

page_size

integerrequired

total_pages

integerrequired

total_records

integerrequired

Errors

Standard JSON-RPC 2.0 error codes apply.

-32600

Invalid Request

erroroptional

-32601

Method not found

erroroptional

-32602

Invalid params

erroroptional

-32603

Internal error

erroroptional

401

Bearer token missing or invalid

erroroptional

403

Actor does not have the required capacity for this operation

erroroptional