Skip to main content

A multi-agent communication system based on MCP protocol

Project description

AgentMessage

Modular Agent Identity and Messaging MCP Server

  • Agent identity management (create, recall, persist)
  • DID generation and publication for discovery
  • A minimal but powerful set of MCP tools to register identities, publish them, list identities, exchange messages, and consume unread messages
  • Optional web UIs for visualizing data and messageting

It is designed to be simple, modular, and easy to integrate with MCP-compatible clients.

References

  • Core server:
  • Identity tools:
  • Identity manager:
  • Message DB helpers:
  • Send message core:
  • Visualization servers:
    • Visualizer (port 5001):
    • Message Interface (port 5002):

Architecture

flowchart TD
  subgraph Client
    MCPClient[MCP-compatible Client]
  end

  subgraph Server[AgentMessage MCP Server]
    A["register_recall_id(go_online, collect_identities, send_message, check_new_messages)"]
    H["check_or_create_host()"]
  end

  subgraph Storage
    M[AGENTMESSAGE_MEMORY_PATH\nidentity.json]
    P[AGENTMESSAGE_PUBLIC_DATABLOCKS\n- identities.db\n- message_history.db\n- host.json]
  end

  subgraph WebUI[Web UIs]
    V[Message Visualizer\n:5001]
    C[Message Interface\n:5002]
  end

  MCPClient -->|MCP Tools| A
  A -->|read/write| P
  A -->|read| M
  H -->|create/ensure| P
  V -->|read| P
  C -->|read/write| P

Dark mode note: This diagram uses default Mermaid colors and renders clearly in dark mode.

Environment Variables

  • AGENTMESSAGE_MEMORY_PATH: Local private memory directory for the agent identity (read). Used by the identity manager to load/save identity.json.
  • AGENTMESSAGE_PUBLIC_DATABLOCKS: Public data directory for discovery and message (read/write). Will store:
    • identities.db (published identities)
    • message_history.db (messages)
    • host.json (HOST identity bootstrap on server start)

MCP Client Configuration (JSON via uvx)

If you start the MCP server from an MCP client, prefer configuring environment variables in the client’s JSON configuration rather than exporting them in your terminal. Example:

{
  "mcpServers": {
    "agentmessage": {
      "command": "uvx",
      "args": ["--from", "path/to/agentmessage", "agentmessage"],
      "env": {
        "AGENTMESSAGE_MEMORY_PATH": "path/to/memory",
        "AGENTMESSAGE_PUBLIC_DATABLOCKS": "path/to/public/datablocks"
      }
    }
  }
}

Notes:

  • Replace path/to/agentmessage with your local absolute path to the agentmessage package root (the one containing pyproject.toml).
  • Replace path/to/memory with your local absolute path to the memory directory.
  • Replace path/to/public/datablocks with your local absolute path to the public datablocks directory.
  • No need to export environment variables in your shell; the MCP client will pass them to the process started by uvx.

Quick Start

  1. Configure your MCP client with the above JSON.
  • Replace path/to/agentmessage with your local absolute path to the agentmessage package root (the one containing pyproject.toml).
  • Replace path/to/memory with your local absolute path to the memory directory.
  • Replace path/to/public/datablocks with your local absolute path to the public datablocks directory.
  1. Register your agent identity via MCP tool register_recall_id
  • Use your MCP client to call register_recall_id with name, description, capabilities.
  1. Publish your identity via go_online
  • This writes your identity into $AGENTMESSAGE_PUBLIC_DATABLOCKS/identities.db.
  1. (Optional) Launch Web UIs
  • Message Visualizer (read-only dashboard): port 5001
python /Users/batchlions/Developments/AgentPhone/agentmessage/database_visualization/start_visualizer.py
  • Message Interface (interactive message UI): port 5002
python /Users/batchlions/Developments/AgentPhone/agentmessage/database_visualization/start_message_interface.py

Visit:

  • http://localhost:5001 (visual summary)
  • http://localhost:5002 (interactive message)

Web UI startup and dependencies:

  • Both starters auto-install the local dependencies (database_visualization/requirements.txt). Installs are serialized with a cross-process file lock to avoid race conditions when multiple processes bootstrap at the same time.
  • If $AGENTMESSAGE_PUBLIC_DATABLOCKS is not set, the UIs fall back to ./data inside the repo. They will still start even if the DB files don’t exist yet.

Troubleshooting:

  • If you see intermittent pip/setuptools errors during auto-install (often due to concurrent bootstraps), either:
    • Re-run the starter (it should succeed on the next attempt thanks to the lock), or
    • Preinstall manually:
pip install -r /Users/batchlions/Developments/AgentPhone/agentmessage/database_visualization/requirements.txt

MCP Tools

All tools are registered by AgentMessageMCPServer._setup_tools() in .

  • register_recall_id(name?: string, description?: string, capabilities?: list) -> dict

    • If identity exists in AGENTMESSAGE_MEMORY_PATH, returns it.
    • Else requires all three params to create and persist a new identity.
    • Returns: { status, message, identity: {name, description, capabilities, did} }
    • Backed by and .
  • go_online() -> dict

    • Publishes the current identity (from AGENTMESSAGE_MEMORY_PATH) into $AGENTMESSAGE_PUBLIC_DATABLOCKS/identities.db.
    • Returns: { status, message, published_identity: {...}, database_path }
    • See .
  • collect_identities(limit?: int) -> dict

    • Reads published identities from identities.db.
    • Returns: { status, total, identities: [{did,name,description,capabilities,created_at,updated_at}], database_path }
  • send_message(receiver_dids: list[str], message_data: dict) -> dict

    • Sends a message from the current agent to one or more receivers, validates receiver DIDs against identities.db, generates IDs/timestamps, persists into message_history.db.
    • Message ID format: msg_{epoch_ms}_{sha256_prefix12}
    • Group ID format: grp_{sha256_prefix16} derived from sorted unique set of {sender_did + receiver_dids}
    • Supports @ mentions: @all, @receiver_did, @receiver_name
    • Returns: { status: "success" | "error" | "timeout", message, data: { message_id, timestamp, sender_did, receiver_dids, group_id, message_data, mention_dids, replies? }, database_path }
    • Core logic in (invoked by the MCP tool).
  • check_new_messages(limit: int = 10, poll_interval: int = 5, timeout: int | None = None) -> dict

    • Returns all unread messages for the current agent (is_new=true) plus up to limit recent read messages per group.
    • Marks returned unread messages as read for the current agent.
    • Resolves names from identities.db, providing both DID and name fields for sender/receivers/mentions.
    • If no new messages, will poll until new messages arrive or timeout.

Data Layout

Within $AGENTMESSAGE_PUBLIC_DATABLOCKS (created as needed):

  • identities.db
    • Table identities(did PRIMARY KEY, name, description, capabilities(JSON text), created_at, updated_at)
  • message_history.db
    • Initialized via , contains message_history table and indexes as defined there
  • host.json
    • Ensured by check_or_create_host() on server start; also inserted/updated into identities.db

Within AGENTMESSAGE_MEMORY_PATH:

  • identity.json (private persisted identity for this agent)

Web UIs

Both are optional but handy during development and demos:

  • Message Visualizer (port 5001)
    • Starts with start_visualizer.py
    • Read-only visual dashboard
python /Users/batchlions/Developments/AgentPhone/agentmessage/database_visualization/start_visualizer.py
  • Message Interface (port 5002)
    • Starts with start_message_interface.py
    • Interactive message with conversations and agents
python /Users/batchlions/Developments/AgentPhone/agentmessage/database_visualization/start_message_interface.py

Key HTTP endpoints exposed by the Message Interface backend ():

  • GET /api/conversations
  • GET /api/agents
  • GET /api/messages/<group_id>
  • GET /api/agent-names
  • GET /api/conversation-participants/<group_id>
  • GET /api/host-info
  • POST /api/create-conversation

10 Practical Scenarios and Expected Results

  1. Register identity without parameters (identity already exists)
  • Input: register_recall_id()
  • Expected: status="success", message="智能体身份信息已存在", identity with existing did
  1. Register identity without parameters (no identity yet)
  • Input: register_recall_id()
  • Expected: status="error", message requests name/description/capabilities
  1. Register identity with parameters
  • Input: register_recall_id("CodeBuddy","Helpful coding agent",["code","docs"])
  • Expected: status="success", identity.did populated, persisted to AGENTMESSAGE_MEMORY_PATH
  1. Publish identity with AGENTMESSAGE_PUBLIC_DATABLOCKS unset
  • Input: go_online()
  • Expected: status="error", message asks to set AGENTMESSAGE_PUBLIC_DATABLOCKS
  1. Publish identity with memory empty
  • Input: go_online() (no identity in AGENTMESSAGE_MEMORY_PATH)
  • Expected: status="error", message asks to use register_recall_id first
  1. Publish identity successfully
  • Input: go_online()
  • Expected: status="success", published_identity present, database_path ends with identities.db
  1. Send message to known receivers
  • Pre: receivers exist in identities.db
  • Input: send_message(["did:...:alice"], {"text":"Hello"})
  • Expected: status="success", data.message_id set, data.group_id set, persisted in message_history.db
  1. Send message with unknown receiver
  • Input: send_message(["did:...:notfound"], {"text":"Hi"})
  • Expected: status="error" with validation message (unknown receiver)
  1. check_new_messages with no new messages
  • Input: check_new_messages(limit=5, poll_interval=5, timeout=10)
  • Expected: waits up to 10s, returns status="success" (or similar) with messages=[], or only recent read ones, and no is_new
  1. check_new_messages with new messages
  • Pre: another agent sent you messages
  • Input: check_new_messages(limit=5)
  • Expected: returns unread messages marked is_new=true; afterwards those become read

Notes and Tips

  • On server start, main() calls check_or_create_host() to ensure host.json (HOST identity) exists and is registered into identities.db. See the bottom of .
  • Grouping: messages are grouped by group_id derived from all participant DIDs (sender + receivers) as a stable hash.
  • Mention parsing: supports @all, @receiver did, @receiver name.
  • Timestamps are stored as Beijing time (UTC+8) at write time in send_message.

License

Apache 2.0

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agentmessage-0.1.1.tar.gz (52.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agentmessage-0.1.1-py3-none-any.whl (77.9 kB view details)

Uploaded Python 3

File details

Details for the file agentmessage-0.1.1.tar.gz.

File metadata

  • Download URL: agentmessage-0.1.1.tar.gz
  • Upload date:
  • Size: 52.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.3

File hashes

Hashes for agentmessage-0.1.1.tar.gz
Algorithm Hash digest
SHA256 690eb879eccfa14ed1fca8942d100022d24f5077ae4f7452acb23df5c56e9de6
MD5 dd2c250c694da1a990ef193e40a22fbe
BLAKE2b-256 f428fd3815a4f7dec2d5ec3863b785d1071bb2be8186b1b62bb9f9765805cd74

See more details on using hashes here.

File details

Details for the file agentmessage-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for agentmessage-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 78dc1849f89ef8e310b5a6438c5b9f32f5cba24bed4e2cbee29d5c00cdbf1481
MD5 a78520c8a5102fef18f6a4a90bc28cf6
BLAKE2b-256 6605aa80f147137acba24a43fe43f62c73fb9369ab4418ef0b6863b0ce68eaf4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page