From de3a780ecf81cdfe8440318e5a27d4ff2120495b Mon Sep 17 00:00:00 2001 From: Nathan Castaldi Date: Wed, 15 Apr 2026 08:25:05 -0400 Subject: [PATCH] docs: update README to remove outdated status page and improve clarity --- README.md | 73 ++++++------------------------------------------------- 1 file changed, 8 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index f51f31c..21d42a1 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,16 @@ # Nexus-MCP — Enterprise Integration Server -Sharded Model Context Protocol server for enterprise systems. -Each shard is self-contained and can be toggled independently via feature flags. +>Sharded Model Context Protocol server for enterprise systems. +> +>Each shard is self-contained and can be toggled independently via feature flags. --- -## Status Page (Managed) - -| Field | Value | -|---|---| -| Last Updated | 2026-04-13 | -| Latest Session Snapshot | SESSION_SNAPSHOT_2026-04-13.md | -| Change Signal | No staged files | -| Components Affected | none | -| TODO/RESTART Markers | none | -| BREAKING CHANGE (compose ports/volumes) | No | - ## Shard Status Board (Traffic Light) | Shard | System(s) | Status | NEXUS Ref | Flag | Standard Gate | -|---|---|---|---|---|---| +| --- | --- | --- | --- | --- | --- | | identity | Active Directory + Entra ID | 🟢 Green | NEXUS-017 | ENABLE_IDENTITY | Tool tests passing | | workday | Workday HCM | 🟡 Yellow | NEXUS-009 | ENABLE_WORKDAY | Credentials + live validation pending | | audit | Cross-system drift + reporting | 🟡 Yellow | NEXUS-018 | ENABLE_AUDIT | Verification maturing | @@ -28,31 +18,9 @@ Each shard is self-contained and can be toggled independently via feature flags. | assets | Lansweeper + Intune | 🔴 Red | NEXUS-022 | ENABLE_ASSETS | Stub only | | logistics | FedEx | 🔴 Red | NEXUS-023 | ENABLE_LOGISTICS | Stub only | -## Discipline Drives Quality - -| Pillar | Target Standard | Current Signal | -|---|---|---| -| Type Hinting | Public interfaces typed | 🟢 Pydantic-based schemas in place | -| Pylance | Zero-error baseline | 🟡 Enforced goal, pending full workspace sweep | -| Modular Structure | Orchestrator -> shards -> adapters | 🟢 Applied in current architecture | -| Test Gates | Pre-push tests + validation | 🟢 Active local gate | -| Security Logging | SOC 2 audit trail with redaction | 🟢 Active | - -## Sprint Traceability (2026) - -| NEXUS ID | Area | Status | -|---|---|---| -| NEXUS-009 | Workday integration | 🟡 In progress | -| NEXUS-017 | Identity integration | 🟢 Production-ready | -| NEXUS-018 | Audit capability | 🟡 In progress | -| NEXUS-021 | ITSM shard | 🔴 Planned | -| NEXUS-022 | Assets shard | 🔴 Planned | -| NEXUS-023 | Logistics shard | 🔴 Planned | - - ## Folder Structure -``` +```plaintext nexus-mcp/ ├── src/ │ ├── main.py # Core Orchestrator — reads flags, loads shards @@ -121,32 +89,7 @@ Leave a shard unregistered (or set flag to `false`) to hold it without breaking --- -## Setup +## Local Use and Demo Guide -```bash -cd nexus-mcp -cp .env.example .env # fill in credentials and set feature flags -pip install -e . -python src/main.py # or: nexus-mcp -``` - -## Claude Desktop config - -```json -{ - "mcpServers": { - "nexus": { - "command": "python", - "args": ["src/main.py"], - "cwd": "/path/to/nexus-mcp" - } - } -} -``` - ---- - -## Required permissions - -See [DEMO_GUIDE.md](DEMO_GUIDE.md) for the full permission matrix, credential configuration, and live-mode setup. -All credentials live in `nexus-mcp/.env` — no need to put them in the Claude config. +- See [DEMO_GUIDE.md](DEMO_GUIDE.md) for the full permission matrix, credential configuration, and live-mode setup. +- All credentials live in `nexus-mcp/.env` — no need to put them in the Claude config.