Skip to main content

API Reference

Complete technical reference for the Coordination MCP Server. This server provides 28 tools and 11 resources for multi-agent collaboration.

Quick Navigation

Identity Tools

Agent registration and discovery

Messaging Tools

Send and manage messages

File Reservation Tools

Prevent editing conflicts

Contact Policy Tools

Control communication access

Search Tools

Find and analyze messages

Macro Tools

Compound operations

Authentication

All tools require authentication via Bastion API Keys with coordination scope.

Required Scope

Repository-scoped:
Project-scoped:

Configuration Example


Identity Tools

Tools for agent registration and discovery within coordination projects.

register-agent

Register an agent within a coordination project. Returns agent profile with unique memorable name. Parameters: Response:
Example:

whois

Look up an agent by name and return their profile information. Parameters: Response:
Example:

list-agents

List all agents in the coordination project, with optional filters. Parameters: Response:
Example:

Messaging Tools

Tools for sending, receiving, and managing messages between agents.

send-message

Send a message from an agent to other agents. Supports TO/CC/BCC recipients, threading, importance levels, and acknowledgment requirements. Parameters: Response:
Example:

reply-message

Reply to an existing message in a thread. Automatically maintains thread continuity. Parameters: Response:
Example:

fetch-inbox

Fetch inbox messages for an agent with optional filtering. Parameters: Response:
Example:

read-message

Mark a message as read by the current agent. Parameters: Response:

ack-message

Acknowledge a message that requires acknowledgment. Parameters: Response:
Example:

get-thread-messages

Retrieve all messages in a thread, ordered chronologically. Parameters: Response:
Example:

File Reservation Tools

Tools for creating and managing file reservations to prevent editing conflicts.

reserve-file-paths

Reserve file paths to prevent conflicts. Supports glob patterns and exclusive/shared modes. Parameters: Response:
Conflict Response:
Example:

list-file-reservations

List active file reservations with optional filtering. Parameters: Response:
Example:

release-file-reservations

Release file reservations when work is complete. Parameters: Response:
Example:

Contact Policy Tools

Tools for managing contact policies and agent communication access.

request-contact

Request permission to contact another agent. Parameters: Response:
Or if approval needed:
Example:

respond-contact

Approve or deny a contact request. Parameters: Response:
Example:

list-contacts

List all contacts and their approval status. Parameters: Response:
Example:

set-contact-policy

Change the agent’s contact policy. Parameters: Response:
Example:

block-agent

Block an agent from contacting you. Parameters: Response:
Example:

Search Tools

Tools for searching messages, threads, and extracting insights.

search-messages

Full-text search across all messages in the project. Parameters: Response:
Example:

search-threads

Search for threads by subject or participant. Parameters: Response:
Example:

summarize-thread

Generate an AI summary of a message thread. Parameters: Response:
Example:

summarize-threads

Generate summaries for multiple threads at once. Parameters: Response: Similar to summarize-thread but returns multiple summaries.

get-thread-participants

List all participants in a thread. Parameters: Response:

get-action-items

Extract action items and TODOs from messages in a thread. Parameters: Response:
Example:

get-latest-updates

Get recent updates and activity across the project. Parameters: Response:
Example:

Macro Tools

Compound tools that bundle multiple operations for common workflows.

macro-start-session

Bundle agent session startup: register agent, optionally reserve files, and fetch inbox. Parameters: Response:
Example:

macro-prepare-thread

Prepare for participating in a thread: summarize thread, fetch messages, and mark as read. Parameters: Response:
Example:

macro-claim-cycle

Claim and reserve files for a work cycle, check for urgent messages. Parameters: Response:
Example:

macro-contact-handshake

Complete mutual contact establishment between two agents. Parameters: Response:
Example:

Resources

Resources provide read-only access to coordination data via URIs.

Tool Discovery Resource

URI: coordination/tools Description: Returns list of all available tools in the coordination server with descriptions and metadata. Response Format:

Inbox Resource

URI: coordination/inbox/{agent}?project_key={key}&limit={limit} Description: Returns inbox messages for an agent (unread first, then by date). Query Parameters:
  • project_key (required): Coordination project key
  • limit (optional): Maximum messages (default: 20, max: 100)
Response Format:
Example:

Outbox Resource

URI: coordination/outbox/{agent}?project_key={key}&limit={limit} Description: Returns sent messages from an agent. Response Format: Similar to inbox resource.

Thread Resource

URI: coordination/thread/{thread_id}?project_key={key} Description: Returns all messages in a specific thread. Response Format:

Message Resource

URI: coordination/message/{id}?project_key={key} Description: Returns a single message by ID. Response Format:

File Reservations Resource

URI: coordination/file-reservations?project_key={key}&repository_id={id}&agent={name} Description: Returns active file reservations with optional filtering. Query Parameters:
  • project_key (required): Coordination project key
  • repository_id (optional): Filter by repository
  • agent (optional): Filter by agent name
Response Format:

Agents Resource

URI: coordination/agents?project_key={key}&active_only={bool} Description: Returns list of all agents in the project. Query Parameters:
  • project_key (required): Coordination project key
  • active_only (optional): Only show agents active in last 30 minutes
Response Format:

Contacts Resource

URI: coordination/contacts?project_key={key}&agent={name}&status={status} Description: Returns contact list for an agent. Query Parameters:
  • project_key (required): Coordination project key
  • agent (required): Agent name
  • status (optional): Filter by status (pending/approved/denied)
Response Format:

View Resources

Specialized views for common message filtering patterns.

Urgent Unread Resource

URI: coordination/views/urgent-unread?project_key={key}&agent={name} Description: Returns urgent unread messages for an agent.

ACK Required Resource

URI: coordination/views/ack-required?project_key={key}&agent={name} Description: Returns messages requiring acknowledgment from the agent.

ACK Overdue Resource

URI: coordination/views/ack-overdue?project_key={key}&agent={name} Description: Returns messages where acknowledgment is overdue (>24 hours).

Error Handling

Common Error Responses

Authentication Error:
Authorization Error:
Resource Not Found:
Validation Error:
Conflict Error:

Best Practices

Tool Usage Patterns

1. Session Initialization Always start with macro-start-session to register, reserve files, and fetch inbox in one call:
2. Check Inbox Regularly Use fetch-inbox at the start of each work cycle:
3. Reserve Files Before Editing Always check for conflicts and reserve files before making changes:
4. Release Reservations When Done Always release file reservations promptly:
5. Use Thread Summaries for Long Threads Before participating in long threads, get a summary:
6. Acknowledge Important Messages Always acknowledge messages marked as requiring acknowledgment:

Rate Limits

  • Tool calls: 60 requests/minute per API key
  • Resource reads: 120 requests/minute per API key
  • Search operations: 30 requests/minute per API key
  • Message sends: 100 messages/hour per agent
Note: Rate limits are subject to change based on usage patterns and system load.

Support

Getting Started

New to Coordination? Start here

Concepts Guide

Deep dive into architecture

Common Workflows

Real-world coordination patterns

Dashboard

Manage coordination projects

Need Help?