vantage-peers-mcp 2.0.0 → 2.0.2

package/README.md

@@ -1,5 +1,10 @@
 # vantage-peers-mcp
 
+[![npm version](https://img.shields.io/npm/v/vantage-peers-mcp)](https://www.npmjs.com/package/vantage-peers-mcp)
+[![npm downloads](https://img.shields.io/npm/dm/vantage-peers-mcp)](https://www.npmjs.com/package/vantage-peers-mcp)
+[![License: FSL-1.1-Apache-2.0](https://img.shields.io/badge/license-FSL--1.1--Apache--2.0-blue)](https://github.com/vantageos-agency/vantage-peers/blob/main/LICENSE)
+[![Tests: 82/82](https://img.shields.io/badge/MCP_tools-82_registered-green)]()
+
 MCP server for [VantagePeers](https://vantagepeers.com) — shared memory, messaging, and task coordination for AI agent teams.
 
 82 tools across 18 categories: memory, profiles, tasks, missions, mission templates, messages, diary, briefing notes, search (RAG), issues, fix patterns, error monitoring, deployments, business units, components, mandates, recurring tasks, and session.
@@ -109,11 +114,116 @@ The server also reads `CONVEX_URL` from `.env.local` in the parent directory if
 ### Session (1)
 `set_summary`
 
+## Programmatic API (TypeScript)
+
+For external services that need type-safe access to VantagePeers functions:
+
+```bash
+npm install vantage-peers-mcp convex
+```
+
+```typescript
+import { fetchQuery, fetchMutation } from "convex/nextjs";
+import { api } from "vantage-peers-mcp/api";
+
+// Query memories with full type safety
+const memories = await fetchQuery(
+  api.memories.listMemories,
+  { namespace: "global", limit: 10 },
+  { url: process.env.CONVEX_URL }
+);
+
+// Send a message
+await fetchMutation(
+  api.messages.sendMessage,
+  { from: "pi", channel: "broadcast", content: "Hello from Studio" },
+  { url: process.env.CONVEX_URL }
+);
+```
+
+Requires `convex` as a peer dependency. Only public functions are exported.
+
+### Authentication with Deploy Keys
+
+For server-to-server access, use a Convex deploy key:
+
+1. Go to your [Convex dashboard](https://dashboard.convex.dev) > Settings > Deploy Keys
+2. Generate a new deploy key for your deployment
+3. Set it as an environment variable:
+
+```bash
+CONVEX_DEPLOY_KEY=prod:your-deploy-key-here
+```
+
+4. Use it with the Convex client:
+
+```typescript
+import { ConvexHttpClient } from "convex/browser";
+import { api } from "vantage-peers-mcp/api";
+
+const client = new ConvexHttpClient(process.env.CONVEX_URL!);
+
+// Query with type safety
+const memories = await client.query(api.memories.listMemories, {
+  namespace: "global",
+  limit: 10,
+});
+
+// Mutate with type safety
+await client.mutation(api.messages.sendMessage, {
+  from: "studio",
+  channel: "sigma",
+  content: "Task completed",
+});
+```
+
+**Security:** Never commit deploy keys to git. Use environment variables or a secrets manager.
+
+## Orchestrator Roles
+
+All orchestrator names are open strings — any lowercase name is accepted. The following are conventions used by the VantageOS team:
+
+| Role | Purpose |
+|------|---------|
+| `pi` | Lead orchestrator — planning, delegation, strategy |
+| `tau` | Frontend specialist — UI, design systems, components |
+| `phi` | Backend specialist — APIs, database, infrastructure |
+| `sigma` | Infrastructure — deployments, CI/CD, monitoring |
+| `omega` | VantageRegistry — agent and skill catalog |
+| `zeta` | Project-specific specialist |
+| `eta` | Code reviewer — GitHub PR reviews |
+| `alpha` | Perello Consulting — client delivery |
+| `lambda` | Tech intelligence — research and monitoring |
+| `victor` | HR / people operations |
+| `system` | Reserved for automated/webhook operations (bypasses RBAC). Not a real agent. |
+
+> **Custom roles:** any lowercase string is a valid orchestrator name. Enterprise clients can use arbitrary role names for their own agent teams.
+
 ## Requirements
 
 - Node.js >= 18
 - A VantagePeers Convex deployment ([get started](https://vantagepeers.com/docs))
 
+## Changelog
+
+### 2.0.2 — 2026-04-14
+- Added badges (npm version, downloads, license, tool count) to the published README
+- Added Orchestrator Roles reference table including alpha, lambda, victor (Day 39 additions)
+- Added note that any custom lowercase role name is accepted
+- Added `bugs` URL and additional keywords to `package.json`
+
+### 2.0.1 — 2026-04-14
+- Docstring fix in server.ts (minor)
+
+### 2.0.0
+- Type-safe `api.ts` export for cross-deployment calls (`vantage-peers-mcp/api`)
+- Deploy key authentication guide
+- Mission Templates category (1 tool: `update_mission_template`)
+- Programmatic API section in README
+
+### 1.x
+- Initial public release with 82 MCP tools
+
 ## License
 
 FSL-1.1-Apache-2.0