@hol-org/hashnet-mcp 1.0.23 → 1.0.24

package/README.md

@@ -1,17 +1,18 @@
 # HOL Hashnet MCP
 
+## Description
 Model Context Protocol (MCP) server for Hashgraph Online’s Registry Broker. It gives AI agents a first-class tool suite to discover, register, and chat with agents/servers on the Hashgraph network, plus workflow shortcuts for common journeys.
 
-## Why use this server?
+## Features
 - **Discovery & chat in one place**: Find UAIDs/agents/MCP servers, validate them, open chat sessions, and send messages via a single MCP endpoint.
 - **Registration flows**: Request quotes, submit HCS-11 registrations, and wait for completion with built-in pipelines.
 - **Ops & credits**: Inspect broker health/metrics, and manage credits (HBAR or X402), with guardrails for required approvals.
 - **DX for agent platforms**: Ships both stdio (great for Claude Desktop) and HTTP streaming/SSE (great for Cursor/Claude Code/Codex).
 
-## Quickstart
-Prereqs: Node 18+, `pnpm` (or npm), and a broker API key.
+## Installation
+Prereqs: Node 18+, `pnpm` (or npm), and (optionally) a Registry Broker API key.
 
-You can get a API key at [hol.org/regsitry](https://hol.org/registry)
+You can get an API key at `https://hol.org/registry`.
 
 1) Install deps and env:
 ```bash
@@ -31,6 +32,13 @@ pnpm quickstart
 ```
 Guides you through copying `.env`, installing deps, running smoke checks, and launching your chosen transport (stdio or sse).
 
+## Configuration
+- `.env` / environment variables:
+  - `REGISTRY_BROKER_API_URL` (default `https://registry.hashgraphonline.com/api/v1`)
+  - `REGISTRY_BROKER_API_KEY` (required for authenticated actions like registration, chat, credit purchases)
+  - Optional: `LOG_LEVEL`, `PORT`, `HTTP_STREAM_PORT`, and `BROKER_*` rate limit vars
+- Memory (optional): set `MEMORY_ENABLED=1` and configure `MEMORY_STORE` / `MEMORY_STORAGE_PATH` (see `help://hol/memory`).
+
 ## Architecture (mental model)
 ```
 Client (Cursor / Claude Code / Claude Desktop / Codex)
@@ -80,6 +88,31 @@ Use `"type": "sse"` if your build expects it.
 }
 ```
 
+## Usage Examples
+### Example 1 — Discover agents and MCP servers
+**User prompt**
+> Find 5 verified MCP servers related to “hashgraph” and summarize what each one does.
+
+**Expected behavior**
+- Calls `hol.search` (and/or `workflow.discovery`) with `type: "mcp-servers"` and `verified: true`
+- Returns a list of candidates with UAIDs and short summaries, and includes suggested next calls
+
+### Example 2 — Start a chat with a UAID
+**User prompt**
+> Send “Can you help me index ERC-8004 agents?” to UAID `uaid:example...` and show the conversation history.
+
+**Expected behavior**
+- Calls `hol.chat.sendMessage { uaid, message }` (auto-creates a session if needed)
+- Calls `hol.chat.history { sessionId }` and returns messages
+
+### Example 3 — Register an MCP server (authenticated)
+**User prompt**
+> Register this MCP server payload and wait for completion: { ...payload... }.
+
+**Expected behavior**
+- Calls `workflow.registerMcp { payload }` (quote → register → wait)
+- If `REGISTRY_BROKER_API_KEY` is missing, asks you to configure it (or use `hol.ledger.challenge` + `hol.ledger.authenticate`)
+
 ## Commands
 - Dev transports: `pnpm dev:stdio` (stdio), `pnpm dev:sse` (HTTP stream/SSE)
 - Build / prod: `pnpm build` then `pnpm start`
@@ -178,3 +211,10 @@ Set in `.env` or your process:
 ## Logging & observability
 - `pino` structured logs; set `LOG_LEVEL=fatal|error|warn|info|debug|trace`.
 - Each tool call logs requestId + duration. SSE/HTTP transport logs requests. Credits/registration calls surface broker status/body on failure.
+
+## Privacy Policy
+`@hol-org/hashnet-mcp` is operated by Hashgraph Online. Privacy policy: `https://hol.org/privacy-policy/`.
+
+## Support
+- Email: `michael@hashgraphonline.com`
+- Issues: `https://github.com/hashgraph-online/hashnet-mcp-js/issues`