Skip to content
This repository was archived by the owner on Feb 23, 2026. It is now read-only.

loominal/warp

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

56 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Warp

The messaging backbone for Loominal.

License: MIT TypeScript Docker Beta

Warp is the foundational MCP server for Loominal. It gives AI agents in Claude Code the ability to communicate across projects and machines via NATS JetStream — persistent, reliable messaging with 17 purpose-built tools.

Beta Software: Core functionality is tested and stable. APIs may still change before v1.0. Suitable for early adopters and non-critical workloads. Feedback welcome!

Warp (noun): In weaving, the warp threads are the vertical threads held in tension on the loom — they form the foundation that the weft threads weave through.

Features

Channel-Based Messaging

  • Channels for organized, topic-based communication
  • Message persistence via NATS JetStream for history retrieval
  • Project isolation with automatic namespace separation
  • Configurable retention policies and custom channels

Cross-Computer Agent Discovery

  • Agent Registry in a shared KV store for discovery across machines
  • Capability matching to find agents with specific skills
  • Direct Messaging via personal inboxes with reliable delivery
  • Heartbeat System with automatic stale agent detection
  • Visibility Controls: private, project-only, user-only, or public

Work Distribution

  • Work Queues with competing consumers for load balancing
  • Capability-based routing sends work to qualified agents
  • Dead Letter Queue captures failed work for debugging and retry
  • Automatic Retries with configurable attempt limits

Unified Agent Identity

  • Stable IDs derived from hostname + project path (same computer + same folder = same agent)
  • Sub-agent hierarchy with parent-child relationships
  • Cross-restart persistence via NATS KV storage

Agent Identity

Agent Identity

  • Persistent identity: Root agents get stable IDs derived from hostname + project path
  • Sub-agent support: Sub-agents derive IDs from parent ID + type
  • Identity storage: Agent identities stored in NATS KV for cross-restart persistence
  • Automatic initialization: Identity is established on first startup and reused thereafter

Prerequisites

  • Node.js 18 or later
  • NATS server with JetStream enabled

Starting NATS with JetStream

# Docker (easiest)
docker run -d --name nats -p 4222:4222 nats:latest -js

# macOS
brew install nats-server && nats-server -js

# Linux
nats-server -js

Installation

Docker (Recommended)

Docker is the preferred method for running Warp as an MCP server:

# Pull the latest image
docker pull ghcr.io/loominal/warp:latest

# Or build locally
docker build -t loominal-warp:latest .

NPM

npm install -g @loominal/warp

Configuration

Claude Code MCP Configuration

Add to your Claude Code settings (~/.claude/settings.json):

{
  "mcpServers": {
    "loominal-warp": {
      "type": "stdio",
      "command": "docker",
      "args": [
        "run", "-i", "--rm",
        "-e", "NATS_URL=nats://localhost:4222",
        "ghcr.io/loominal/warp:latest"
      ]
    }
  }
}

For remote NATS servers, update the NATS_URL value:

{
  "mcpServers": {
    "loominal-warp": {
      "type": "stdio",
      "command": "docker",
      "args": [
        "run", "-i", "--rm",
        "-e", "NATS_URL=nats://your-nats-server:4222",
        "ghcr.io/loominal/warp:latest"
      ]
    }
  }
}

Project Configuration

Create a .loominal-config.json in your project root:

{
  "namespace": "my-project",
  "channels": [
    {
      "name": "planning",
      "description": "Sprint planning and prioritization",
      "maxMessages": 5000,
      "maxAge": "7d"
    },
    {
      "name": "implementation",
      "description": "Development work coordination"
    },
    {
      "name": "review",
      "description": "Code review discussions"
    }
  ]
}

Default Channels

If no configuration is provided, these default channels are created:

  • roadmap: Discussion about project roadmap and planning
  • parallel-work: Coordination for parallel work among agents
  • errors: Error reporting and troubleshooting

MCP Tools

Warp provides 20 MCP tools organized into categories:

Category Tools Purpose
Identity warp_handle_set, warp_handle_get Set/get your agent name for messages
Channels warp_channels_list, warp_channels_send, warp_channels_read, warp_channels_status Topic-based pub/sub messaging
Registry warp_registry_register, warp_registry_discover, warp_registry_get_info, warp_registry_update_presence, warp_registry_deregister Agent discovery and presence
Direct Messages warp_messages_send_direct, warp_messages_read_direct Agent-to-agent communication
Work Queues warp_work_broadcast, warp_work_claim, warp_work_list, warp_work_queue_status Capability-based work distribution
Dead Letter warp_dlq_list, warp_dlq_retry, warp_dlq_discard Handle failed work items

Each tool includes detailed descriptions visible in your MCP client. Common usage:

// Register and discover
warp_registry_register({ agentType: "developer", capabilities: ["typescript"] })
warp_registry_discover({ capability: "code-review" })
warp_registry_discover({ capability: "testing", limit: 10, cursor: "..." })  // Pagination

// Channel messaging
warp_channels_send({ channel: "planning", message: "Starting sprint 5" })
warp_channels_read({ channel: "roadmap" })                                 // Last 50 messages (default)
warp_channels_read({ channel: "roadmap", limit: 10, cursor: "..." })      // Pagination
warp_channels_status({ channel: "errors" })                                 // Check specific channel
warp_channels_status({})                                                    // Check all channels

// Direct messaging
warp_messages_send_direct({ recipientGuid: "...", message: "Please review PR #42" })
warp_messages_read_direct({ limit: 20 })                                    // Read inbox
warp_messages_read_direct({ messageType: "help-request", cursor: "..." })  // Filter and paginate

// Work distribution
warp_work_broadcast({
  taskId: "task-1",
  description: "Fix bug",
  requiredCapability: "typescript",
  priority: 8
})
warp_work_claim({ capability: "typescript" })
warp_work_list({ capability: "typescript", minPriority: 7 })                // Preview before claiming
warp_work_queue_status({ capability: "typescript" })                        // Check queue depth
warp_work_queue_status({})                                                  // All non-empty queues

// Failed work handling
warp_dlq_list({ capability: "typescript", limit: 20 })       // Pagination support
warp_dlq_retry({ itemId: "...", resetAttempts: true })
warp_dlq_discard({ itemId: "..." })

Pagination (v0.4.0+)

Several tools support pagination for handling large result sets:

  • warp_channels_read: Page through channel message history
  • warp_messages_read_direct: Page through inbox messages
  • warp_registry_discover: Page through agent registry results
  • warp_dlq_list: Page through failed work items

Pagination Pattern:

// First request - returns up to 'limit' items
const response1 = await warp_channels_read({ channel: "roadmap", limit: 50 });

// Response includes pagination metadata:
// {
//   count: 50,              // Items returned in this response
//   total: 847,             // Total items available
//   hasMore: true,          // More items available
//   nextCursor: "eyJ..."    // Base64url-encoded cursor for next page
// }

// Subsequent request - use cursor from previous response
const response2 = await warp_channels_read({
  channel: "roadmap",
  limit: 50,
  cursor: response1.nextCursor
});

Cursor Format: Cursors are base64url-encoded JSON containing offset, limit, and filter hash. They're opaque strings - don't parse or modify them. If filters change between requests, the cursor is invalidated.

Truncation Metadata (v0.3.0+)

Tools that may return large result sets include truncation hints:

  • warp_work_list: Shows if work queue results were limited
  • Other list-based tools provide guidance when results are truncated

Example:

warp_work_list({ capability: "typescript", limit: 20 });

// If more than 20 items exist, response includes:
// "Showing first 20 of 125 items. Increase 'limit' (max: 100) or use filters:
//  minPriority, maxPriority, deadlineBefore, deadlineAfter"

Environment Variables

Variable Default Description
NATS_URL nats://localhost:4222 NATS server connection URL (supports credentials in URL)
NATS_USER (none) Username for NATS authentication (fallback if not in URL)
NATS_PASS (none) Password for NATS authentication (fallback if not in URL)
MCP_PROJECT_PATH Current directory Override project path for config discovery
LOOMINAL_PROJECT_ID (derived from path) Project identifier for isolation
LOOMINAL_AGENT_ID (derived from hostname + path) Manual agent ID override for multi-machine scenarios
LOOMINAL_SUBAGENT_TYPE (none) Set when running as a sub-agent (e.g., "explore", "plan")
LOG_LEVEL INFO Logging level (DEBUG, INFO, WARN, ERROR)
WORKQUEUE_ACK_TIMEOUT 300000 Work acknowledgment timeout (ms)
WORKQUEUE_MAX_ATTEMPTS 3 Max delivery attempts before DLQ
WORKQUEUE_DLQ_TTL 604800000 Dead letter queue TTL (ms, default 7 days)

NATS Authentication

Authentication is optional. For local development, just use nats://localhost:4222.

For production NATS servers with authentication enabled:

Option 1: Credentials in URL (recommended)

NATS_URL=nats://myuser:mypassword@nats.example.com:4222

Option 2: Separate environment variables

NATS_URL=nats://nats.example.com:4222
NATS_USER=myuser
NATS_PASS=mypassword

Option 3: Mixed (user in URL, password in env)

NATS_URL=nats://myuser@nats.example.com:4222
NATS_PASS=mypassword

URL credentials take precedence over environment variables. Special characters in passwords should be URL-encoded (e.g., @%40, /%2F).

WebSocket Transport

Warp supports WebSocket connections for environments where raw TCP is not available (e.g., through CDN proxies like Cloudflare):

# WebSocket (for proxied connections)
NATS_URL=wss://myuser:mypassword@nats.example.com

# WebSocket without TLS (local testing only)
NATS_URL=ws://localhost:8080

The transport is auto-detected from the URL scheme:

  • nats:// or tls:// → TCP connection
  • ws:// or wss:// → WebSocket connection

GitHub Actions

Warp can connect to NATS from GitHub Actions runners using WebSocket transport. This enables spinning up ephemeral agents that can claim work from the queue.

Setup

  1. Add repository secret NATS_URL with your WebSocket URL:

    wss://github-agent:password@nats.example.com
    
  2. Use the agent workflow (.github/workflows/agent.yml):

    • Manually trigger via "Actions" → "Loom Agent" → "Run workflow"
    • The workflow validates NATS connectivity through Cloudflare/proxy

Example: Full Agent Workflow

To run a complete Claude Code agent in GitHub Actions:

- name: Install Claude Code
  run: npm install -g @anthropic-ai/claude-code

- name: Configure MCP
  run: |
    mkdir -p ~/.claude
    cat > ~/.claude/mcp.json << 'EOF'
    {
      "mcpServers": {
        "loominal-warp": {
          "type": "stdio",
          "command": "docker",
          "args": ["run", "-i", "--rm", "-e", "NATS_URL", "ghcr.io/loominal/warp:latest"]
        }
      }
    }
    EOF

- name: Run Agent
  env:
    NATS_URL: ${{ secrets.NATS_URL }}
    ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
  run: |
    claude-code --print "Register as github-runner, claim typescript work, and execute it"

Cross-Computer Setup

To enable agents on different computers to communicate:

1. Deploy a Shared NATS Server

# Kubernetes (production)
kubectl apply -f config/

# Or use a cloud NATS service

2. Configure Each Computer

Point all Warp instances to the same NATS URL:

{
  "mcpServers": {
    "loominal": {
      "command": "warp",
      "env": {
        "NATS_URL": "nats://your-shared-nats-server:4222"
      }
    }
  }
}

3. Register and Discover

Each agent calls warp_registry_register → automatically discoverable across all computers.

Visibility Controls

Visibility Who can discover
private Only the agent itself
project-only Agents in the same project (default)
user-only Agents with the same username
public All agents on the NATS server

Kubernetes Deployment

Deploy NATS with JetStream for production multi-computer setups.

# Apply manifests
kubectl apply -f config/

# Verify
kubectl get pods -n loominal
kubectl get svc -n loominal

See config/README.md for detailed deployment instructions.

Known Limitations

The following limitations are known in the current Beta release:

  • Stale agent detection: Heartbeat-based offline detection requires the Weft coordinator. Without Weft, agents may appear online indefinitely after disconnect.
  • Work queue backpressure: Under high load, NATS JetStream may return 503 errors during rapid publish/consume cycles. Implement retry logic for production workloads.
  • Single NATS server: Clustering and high-availability NATS configurations are not yet tested. Use a single NATS server for now.
  • Message ordering: Channel messages are ordered by publish time, but rapid concurrent publishes may have slight ordering variations.

Troubleshooting

NATS Connection Failed

Error: NATS connection failed

Solution: Ensure NATS is running with JetStream:

nats-server -js

JetStream Not Enabled

Error: JetStream not enabled

Solution: Start NATS with the -js flag.

Invalid Channel Name

Error: Invalid channel name

Solution: Use lowercase alphanumeric with hyphens only (my-channel, sprint-1).

NATS Authorization Failed

Error: AUTHORIZATION_VIOLATION

Solution: Check your NATS credentials:

  • Verify NATS_USER and NATS_PASS are correct
  • If using URL credentials, ensure special characters are URL-encoded
  • Confirm the user exists on the NATS server

Development

# Install dependencies
npm install

# Build
npm run build

# Development mode
npm run dev

# Run tests
npm test

# Test coverage
npm run test:coverage

Related

License

MIT

About

Warp - The messaging backbone for Loominal multi-agent infrastructure

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors