Skip to main content
Glama
README.md
# NeedRail

[![CI](https://github.com/ANAMIZED/needrail/actions/workflows/ci.yml/badge.svg)](https://github.com/ANAMIZED/needrail/actions/workflows/ci.yml)
[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
[![MCP](https://img.shields.io/badge/MCP-server-purple.svg)](src/needrail/mcp_server.py)

**NeedRail — Get what you NEED to succeed & do agentic public good.**

Agent-native coordination layer for public goods (MCP + x402 + Needs).

### Support the work

NeedRail is funded by donations and sponsorships only. There is no commercial seat or metered search SKU.

| Option | Amount | Link |
|--------|--------|------|
| **Public Goods Support** | $25 | [Donate](https://donate.stripe.com/00w5kE3wOg5L8Jn2F243S00) |
| **Monthly Sponsor** | $25/mo | [Sponsor](https://donate.stripe.com/dRm28s4AS5r75xb1AY43S0c) |
| **Kernel Support** | $99 | [Donate](https://buy.stripe.com/bJecN63wObPv6Bf7Zm43S02) |

Agent rail: [x402-cloudflare-starter](https://github.com/ANAMIZED/x402-cloudflare-starter)

## Surfaces

| Surface | Entry |
|---------|-------|
| **MCP (stdio)** | `python -m needrail.mcp_server` |
| **CLI** | `needrail-cli status` |
| **API** | `needrail` |
| **SDK** | `from needrail.sdk import NeedRailClient` |

## MCP client configuration

No API keys required to list or call registry tools.

```json
{
  "mcpServers": {
    "needrail": {
      "command": "python",
      "args": ["-m", "needrail.mcp_server"],
      "env": {
        "NEEDRAIL_DATA_DIR": "./data"
      }
    }
  }
}
```

Claude Desktop: paste that block into `claude_desktop_config.json`.
Cursor: `.cursor/mcp.json`. Glama: Deploy the repo Dockerfile (`CMD python -m needrail.mcp_server`).

## Quick Start

```bash
pip install -e .
python -m needrail.mcp_server
```

## License

Apache-2.0

TDQS

A4.5/5.0

Scored across 10 tools

Disambiguation5/5

Each tool targets a distinct resource and action: project discovery vs. need browsing vs. state transitions vs. receipt auditing. The descriptions also cross-reference one another to prevent confusion between similar operations like fund_need and record_payment.

Naming Consistency5/5

All tool names consistently follow a verb_noun snake_case pattern, e.g., list_projects, get_need, create_need, record_payment. There are no mixed conventions or vague generic verbs.

Tool Count5/5

Ten tools is well-scoped for a NeedRail domain covering project lookup, need CRUD basics, funding, payment recording, claiming, completion, and receipts. Each tool covers a meaningful step in the workflow without redundancy.

Completeness4/5

The core need lifecycle is well covered: create, browse, fund, record payment, claim, complete, and audit receipts. Minor gaps exist, such as no project creation/update, no need editing, and no cancellation or close operation, but agents can complete the primary workflow without dead ends.

Maintenance

ActivityMaintained
ResponsivenessNo issues