--- title: "Fastmail address book" description: "Reuses the provider-neutral contacts adapter, preserving group scope, versioning and pagination." --- > Documentation Index > Fetch the complete documentation index at: https://help.tooluse.net/llms.txt > Use this file to discover all available pages before exploring further. # Fastmail address book

Reuses the provider-neutral contacts adapter, preserving group scope, versioning and pagination.

What you can do (8)

What you can do

Available commands: 8 (3 read, 5 write). Enable only the commands your application needs.

Command Effect
Browse address books and groups — fastmail-contacts.scopes Read
Read contact changes — fastmail-contacts.list Read
Read a contact — fastmail-contacts.get Read
Create a contact — fastmail-contacts.contact.create Write
Update or clear contact fields by version — fastmail-contacts.contact.update Write
Delete a contact by version — fastmail-contacts.contact.delete Write
Add a contact to a group — fastmail-contacts.membership.add Write
Remove a contact from a group — fastmail-contacts.membership.remove Write

Connect and use

Connect and use

Open the integration's connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.

Get your provider credentials

Follow these steps for Fastmail address book, then enter the issued values in the connection form below.

  1. In Fastmail Settings → Privacy & Security → Manage API tokens, create a token with the required mail or contacts access. Obtain the account and mailbox identifiers from the JMAP session/API as required by the form.

Official credential setup

Where to enter credentials

In the integration page, sign in, choose your workspace and open Connect. If a Credentials choice is shown, select Use my credentials. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.

Connection field Requirement
Access token Required
Account ID Required

Open API keys and create a Tooluse.net key for the enabled commands.

Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.

Configure Claude Code, Codex or Cursor once

Permissions and results

If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net's existing permissions. Disabling a connection or revoking a key immediately prevents new calls.

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Your connection's daily allowance and key permissions also apply. Adding a connection does not make a provider request.

Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.

Call from your client

Use the shared MCP configuration. Refresh your client's tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.

Configure Claude Code, Codex or Cursor once

Discover your enabled tools

List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.

curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"

Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.

HTTP call

curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {}
}'

Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.

Commands

Browse address books and groups — fastmail-contacts.scopes

Run Browse address books and groups with Fastmail address book. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

This tool has no input parameters.

Full JSON Schema

Full JSON Schema

Example input

{}

At most 10 provider requests per invocation; timeout: 30 seconds.

Read contact changes — fastmail-contacts.list

Run Read contact changes with Fastmail address book. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
scopeIds array Required Group or address book ID minItems: 1; maxItems: 5; uniqueItems: true
scopeIds[] string Optional Value minLength: 1; maxLength: 2000
pageToken string Optional Next page cursor minLength: 1; maxLength: 2000
pageSize integer Optional Items per page minimum: 1; maximum: 50
cursor string Optional Incremental change cursor minLength: 1; maxLength: 2000
cursorIssuedAt string Optional Cursor issue time minLength: 1; maxLength: 100; format: "date-time"

Full JSON Schema

Full JSON Schema

Example input

{
  "scopeIds": [
    "Default"
  ],
  "pageSize": 20
}

At most 20 provider requests per invocation; timeout: 30 seconds.

Read a contact — fastmail-contacts.get

Run Read a contact with Fastmail address book. This is a read command; it does not grant access beyond the connected account's permissions.

This is a read operation. Provider rate limits and data access rules still apply.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
resourceIds array Required Contact ID minItems: 1; maxItems: 20; uniqueItems: true
resourceIds[] string Optional Value minLength: 1; maxLength: 2000

Full JSON Schema

Full JSON Schema

Example input

{
  "resourceIds": [
    "contact-id"
  ]
}

At most 2 provider requests per invocation; timeout: 30 seconds.

Create a contact — fastmail-contacts.contact.create

Run Create a contact with Fastmail address book. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
scopeId string Required Address book or group ID minLength: 1; maxLength: 2000
name object Optional Name additionalProperties: false
name.display string Required Display name minLength: 1; maxLength: 500
name.prefix string Optional Prefix minLength: 1; maxLength: 100
name.given string Optional Given name minLength: 1; maxLength: 200
name.middle string Optional Middle name minLength: 1; maxLength: 200
name.family string Optional Family name minLength: 1; maxLength: 200
name.suffix string Optional Suffix minLength: 1; maxLength: 100
emails array Optional Email addresses minItems: 1; maxItems: 20; uniqueItems: false
emails[] object Optional Email address additionalProperties: false
emails[].value string Required Value minLength: 1; maxLength: 2000
emails[].type string Optional Type minLength: 1; maxLength: 100
emails[].label string Optional Label minLength: 1; maxLength: 200
emails[].primary boolean Optional Primary
phones array Optional Phone numbers minItems: 1; maxItems: 20; uniqueItems: false
phones[] object Optional Phone number additionalProperties: false
phones[].value string Required Value minLength: 1; maxLength: 2000
phones[].type string Optional Type minLength: 1; maxLength: 100
phones[].label string Optional Label minLength: 1; maxLength: 200
phones[].primary boolean Optional Primary
organizations array Optional Organizations minItems: 1; maxItems: 10; uniqueItems: false
organizations[] object Optional Organization additionalProperties: false
organizations[].name string Required Organization name minLength: 1; maxLength: 500
organizations[].department string Optional Department minLength: 1; maxLength: 300
organizations[].title string Optional Job title minLength: 1; maxLength: 300
organizations[].type string Optional Type minLength: 1; maxLength: 100
organizations[].primary boolean Optional Primary
addresses array Optional Addresses minItems: 1; maxItems: 10; uniqueItems: false
addresses[] object Optional Address additionalProperties: false
addresses[].formatted string Optional Formatted address minLength: 1; maxLength: 2000
addresses[].street string Optional Street minLength: 1; maxLength: 500
addresses[].locality string Optional City or locality minLength: 1; maxLength: 200
addresses[].region string Optional Region minLength: 1; maxLength: 200
addresses[].postalCode string Optional Postal code minLength: 1; maxLength: 100
addresses[].country string Optional Country minLength: 1; maxLength: 200
addresses[].countryCode string Optional Country code minLength: 1; maxLength: 2; pattern: "^[A-Za-z]{2}$"
addresses[].type string Optional Type minLength: 1; maxLength: 100
addresses[].label string Optional Label minLength: 1; maxLength: 200
addresses[].primary boolean Optional Primary
urls array Optional Websites minItems: 1; maxItems: 20; uniqueItems: false
urls[] object Optional Website additionalProperties: false
urls[].value string Required Value minLength: 1; maxLength: 2000
urls[].type string Optional Type minLength: 1; maxLength: 100
urls[].label string Optional Label minLength: 1; maxLength: 200
urls[].primary boolean Optional Primary
notes array Optional Notes minItems: 1; maxItems: 20; uniqueItems: true
notes[] string Optional Note minLength: 1; maxLength: 5000

Full JSON Schema

Full JSON Schema

Example input

{
  "scopeId": "Default",
  "name": {
    "display": "Jane Doe",
    "given": "Jane",
    "family": "Doe"
  },
  "emails": [
    {
      "value": "jane@example.com",
      "type": "work",
      "primary": true
    }
  ]
}

At most 2 provider requests per invocation; timeout: 30 seconds.

Update or clear contact fields by version — fastmail-contacts.contact.update

Run Update or clear contact fields by version with Fastmail address book. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
resourceId string Required Contact ID minLength: 1; maxLength: 2000
revision string Required Expected provider revision minLength: 1; maxLength: 2000
name object Optional Name additionalProperties: false
name.display string Required Display name minLength: 1; maxLength: 500
name.prefix string Optional Prefix minLength: 1; maxLength: 100
name.given string Optional Given name minLength: 1; maxLength: 200
name.middle string Optional Middle name minLength: 1; maxLength: 200
name.family string Optional Family name minLength: 1; maxLength: 200
name.suffix string Optional Suffix minLength: 1; maxLength: 100
emails array Optional Email addresses minItems: 0; maxItems: 20; uniqueItems: false
emails[] object Optional Email address additionalProperties: false
emails[].value string Required Value minLength: 1; maxLength: 2000
emails[].type string Optional Type minLength: 1; maxLength: 100
emails[].label string Optional Label minLength: 1; maxLength: 200
emails[].primary boolean Optional Primary
phones array Optional Phone numbers minItems: 0; maxItems: 20; uniqueItems: false
phones[] object Optional Phone number additionalProperties: false
phones[].value string Required Value minLength: 1; maxLength: 2000
phones[].type string Optional Type minLength: 1; maxLength: 100
phones[].label string Optional Label minLength: 1; maxLength: 200
phones[].primary boolean Optional Primary
organizations array Optional Organizations minItems: 0; maxItems: 10; uniqueItems: false
organizations[] object Optional Organization additionalProperties: false
organizations[].name string Required Organization name minLength: 1; maxLength: 500
organizations[].department string Optional Department minLength: 1; maxLength: 300
organizations[].title string Optional Job title minLength: 1; maxLength: 300
organizations[].type string Optional Type minLength: 1; maxLength: 100
organizations[].primary boolean Optional Primary
addresses array Optional Addresses minItems: 0; maxItems: 10; uniqueItems: false
addresses[] object Optional Address additionalProperties: false
addresses[].formatted string Optional Formatted address minLength: 1; maxLength: 2000
addresses[].street string Optional Street minLength: 1; maxLength: 500
addresses[].locality string Optional City or locality minLength: 1; maxLength: 200
addresses[].region string Optional Region minLength: 1; maxLength: 200
addresses[].postalCode string Optional Postal code minLength: 1; maxLength: 100
addresses[].country string Optional Country minLength: 1; maxLength: 200
addresses[].countryCode string Optional Country code minLength: 1; maxLength: 2; pattern: "^[A-Za-z]{2}$"
addresses[].type string Optional Type minLength: 1; maxLength: 100
addresses[].label string Optional Label minLength: 1; maxLength: 200
addresses[].primary boolean Optional Primary
urls array Optional Websites minItems: 0; maxItems: 20; uniqueItems: false
urls[] object Optional Website additionalProperties: false
urls[].value string Required Value minLength: 1; maxLength: 2000
urls[].type string Optional Type minLength: 1; maxLength: 100
urls[].label string Optional Label minLength: 1; maxLength: 200
urls[].primary boolean Optional Primary
notes array Optional Notes minItems: 0; maxItems: 20; uniqueItems: true
notes[] string Optional Note minLength: 1; maxLength: 5000
clearName boolean Optional Clear the saved name

Full JSON Schema

Full JSON Schema

Example input

{
  "resourceId": "contact-id",
  "revision": "current-revision",
  "name": {
    "display": "Jane Smith",
    "given": "Jane",
    "family": "Smith"
  }
}

At most 2 provider requests per invocation; timeout: 30 seconds.

Delete a contact by version — fastmail-contacts.contact.delete

Run Delete a contact by version with Fastmail address book. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
resourceId string Required Contact ID minLength: 1; maxLength: 2000
revision string Required Expected provider revision minLength: 1; maxLength: 2000

Full JSON Schema

Full JSON Schema

Example input

{
  "resourceId": "contact-id",
  "revision": "current-revision"
}

At most 2 provider requests per invocation; timeout: 30 seconds.

Add a contact to a group — fastmail-contacts.membership.add

Run Add a contact to a group with Fastmail address book. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
resourceId string Required Contact ID minLength: 1; maxLength: 2000
revision string Required Expected provider revision minLength: 1; maxLength: 2000
scopeId string Required Group or address book ID minLength: 1; maxLength: 2000

Full JSON Schema

Full JSON Schema

Example input

{
  "resourceId": "contact-id",
  "revision": "current-revision",
  "scopeId": "Default"
}

At most 2 provider requests per invocation; timeout: 30 seconds.

Remove a contact from a group — fastmail-contacts.membership.remove

Run Remove a contact from a group with Fastmail address book. This command can change provider data. Review the target and input before invoking it.

This operation can change provider data. Review the input before allowing an agent to call it.

Connect and use

Parameters

Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.

Parameter Type Required in parent Description Constraints
resourceId string Required Contact ID minLength: 1; maxLength: 2000
revision string Required Expected provider revision minLength: 1; maxLength: 2000
scopeId string Required Group or address book ID minLength: 1; maxLength: 2000

Full JSON Schema

Full JSON Schema

Example input

{
  "resourceId": "contact-id",
  "revision": "current-revision",
  "scopeId": "Default"
}

At most 2 provider requests per invocation; timeout: 30 seconds.

Errors

Check the key's expiry, revocation, workspace and allowed operations.

Reuse the same idempotency key only for the same request.

The connection or provider limit has been reached. Check the receipt before retrying.

Test the connection

Open the integration's commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client's tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.

Official provider documentation

Source: https://help.tooluse.net/integrations/fastmail-contacts/index.mdx