midnight-mcp 0.1.7 → 0.1.9

package/README.md

@@ -10,97 +10,86 @@ MCP server that gives AI assistants access to Midnight blockchain—search contr
 
 ## Quick Start
 
-### Claude Desktop
-
-Add to your `claude_desktop_config.json`:
+**Claude Desktop** — Add to `claude_desktop_config.json`:
 
 ```json
 {
   "mcpServers": {
-    "midnight": {
-      "command": "npx",
-      "args": ["-y", "midnight-mcp"]
-    }
+    "midnight": { "command": "npx", "args": ["-y", "midnight-mcp"] }
   }
 }
 ```
 
-<details>
-<summary><strong>Config file locations</strong></summary>
-
-- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
-- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
-- **Linux**: `~/.config/Claude/claude_desktop_config.json`
-
-</details>
-
-### Cursor
-
-**Click the button to auto install the MCP for Cursor**
+**Cursor** — One-click install:
 
 [![Install MCP Server](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=midnight&config=eyJjb21tYW5kIjoibnB4IC15IG1pZG5pZ2h0LW1jcCJ9)
 
----
-**Manual setup instructions are below if you need them:**
+<details>
+<summary><strong>Other Editors (Windsurf, VS Code Copilot, Manual Setup)</strong></summary>
 
-Add to Cursor's MCP settings (Settings → MCP → Add Server):
+**Windsurf** — Add to `~/.codeium/windsurf/mcp_config.json`:
 
 ```json
 {
   "mcpServers": {
-    "midnight": {
-      "command": "npx",
-      "args": ["-y", "midnight-mcp"]
-    }
+    "midnight": { "command": "npx", "args": ["-y", "midnight-mcp"] }
   }
 }
 ```
 
-Or add to `.cursor/mcp.json` in your project:
+**VS Code Copilot** — Add to `.vscode/mcp.json` or use Command Palette: `MCP: Add Server` → "command (stdio)" → `npx -y midnight-mcp`
 
 ```json
 {
   "mcpServers": {
-    "midnight": {
-      "command": "npx",
-      "args": ["-y", "midnight-mcp"]
-    }
+    "midnight": { "command": "npx", "args": ["-y", "midnight-mcp"] }
   }
 }
 ```
 
-
-
-### Windsurf
-
-Add to `~/.codeium/windsurf/mcp_config.json`:
+**Cursor Manual** — Settings → MCP → Add Server, or add to `.cursor/mcp.json`:
 
 ```json
 {
   "mcpServers": {
-    "midnight": {
-      "command": "npx",
-      "args": ["-y", "midnight-mcp"]
-    }
+    "midnight": { "command": "npx", "args": ["-y", "midnight-mcp"] }
   }
 }
 ```
 
----
+**Config file locations (Claude Desktop):**
 
-Restart your editor after adding the config. All features work out of the box—no API keys or setup required.
+- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
+- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
+- Linux: `~/.config/Claude/claude_desktop_config.json`
+
+</details>
+
+Restart your editor after adding the config. **No API keys required.**
+
+> **Quality Metrics**: To ensure the MCP stays accurate as Midnight's codebase evolves rapidly, we collect anonymous usage metrics (query counts, relevance scores) to monitor search quality. No query content or personal data is stored. This helps us identify when re-indexing is needed and improve results over time.
 
 ---
 
-## How It Works
+## Features
 
-By default, the MCP uses a **hosted API** for semantic search:
+**19 Tools** — Search, analyze, version tracking, AI generation
 
-- **Zero configuration** — just install and use
-- **Semantic search** works immediately
-- **No API keys** needed
+| Category      | Tools                                                                                                                                                                                   |
+| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Search        | `midnight-search-compact`, `midnight-search-typescript`, `midnight-search-docs`                                                                                                         |
+| Analysis      | `midnight-analyze-contract`, `midnight-explain-circuit`                                                                                                                                 |
+| Repository    | `midnight-get-file`, `midnight-list-examples`, `midnight-get-latest-updates`                                                                                                            |
+| Versioning    | `midnight-get-version-info`, `midnight-check-breaking-changes`, `midnight-get-migration-guide`, `midnight-get-file-at-version`, `midnight-compare-syntax`, `midnight-get-latest-syntax` |
+| AI Generation | `midnight-generate-contract`, `midnight-review-contract`, `midnight-document-contract`                                                                                                  |
+| Status        | `midnight-health-check`, `midnight-get-status`                                                                                                                                          |
 
-> **Quality Metrics**: To ensure the MCP stays accurate as Midnight's codebase evolves rapidly, we collect anonymous usage metrics (query counts, relevance scores) to monitor search quality. No query content or personal data is stored. This helps us identify when re-indexing is needed and improve results over time.
+**9 Embedded Resources** — Quick references available offline: Compact syntax, SDK API, OpenZeppelin contracts, tokenomics, wallet integration, common errors
+
+**5 Prompts** — `create-contract`, `review-contract`, `explain-concept`, `compare-approaches`, `debug-contract`
+
+<details>
+<summary><strong>Advanced Configuration</strong></summary>
 
 ### Local Mode (Optional)
 
@@ -122,117 +111,58 @@ Run everything locally for privacy or offline use:
 }
 ```
 
-Local mode requires ChromaDB (`docker run -d -p 8000:8000 chromadb/chroma`) and an OpenAI API key.
+Requires ChromaDB (`docker run -d -p 8000:8000 chromadb/chroma`) and OpenAI API key.
 
 ### GitHub Token (Optional)
 
 Add `"GITHUB_TOKEN": "ghp_..."` for higher GitHub API rate limits (60 → 5000 requests/hour).
 
+</details>
+
 ---
 
-## Features
+## Indexed Repositories
+
+The API indexes **22+ Midnight repositories**:
 
-### Tools (19)
-
-| Tool                              | Description                                 |
-| --------------------------------- | ------------------------------------------- |
-| `midnight-search-compact`         | Search Compact contract code                |
-| `midnight-search-typescript`      | Search TypeScript SDK                       |
-| `midnight-search-docs`            | Search documentation                        |
-| `midnight-analyze-contract`       | Analyze contract structure and security     |
-| `midnight-explain-circuit`        | Explain circuits in plain language          |
-| `midnight-get-file`               | Get files from Midnight repos               |
-| `midnight-list-examples`          | List example contracts                      |
-| `midnight-get-latest-updates`     | Recent repo changes                         |
-| `midnight-get-version-info`       | Get version and release info                |
-| `midnight-check-breaking-changes` | Check for breaking changes                  |
-| `midnight-get-migration-guide`    | Migration guides between versions           |
-| `midnight-get-file-at-version`    | Get file at specific version                |
-| `midnight-compare-syntax`         | Compare files between versions              |
-| `midnight-get-latest-syntax`      | Latest syntax reference                     |
-| `midnight-health-check`           | Check server health status                  |
-| `midnight-get-status`             | Get rate limits and cache stats             |
-| `midnight-generate-contract`      | AI-generate contracts from natural language |
-| `midnight-review-contract`        | AI-powered security review of contracts     |
-| `midnight-document-contract`      | AI-generate documentation for contracts     |
-
-> **Note:** The AI-powered tools require a client with [MCP Sampling](https://spec.modelcontextprotocol.io/specification/client/sampling/) support (e.g., Claude Desktop). Without sampling, these tools will return a helpful message instead.
-
-### Resource Templates (4)
-
-Dynamic access to any resource using URI templates:
-
-| Template                                | Description                    |
-| --------------------------------------- | ------------------------------ |
-| `midnight://code/{owner}/{repo}/{path}` | Any code file from any repo    |
-| `midnight://docs/{section}/{topic}`     | Documentation by section/topic |
-| `midnight://examples/{category}/{name}` | Example contracts by category  |
-| `midnight://schema/{type}`              | JSON schemas (AST, tx, proofs) |
-
-### Resources (20)
-
-- `midnight://docs/*` — Documentation (Compact reference, SDK API, ZK concepts)
-- `midnight://code/*` — Examples, patterns, and templates
-- `midnight://schema/*` — AST, transaction, and proof schemas
-
-### Prompts (5)
-
-- `midnight:create-contract` — Create new contracts
-- `midnight:review-contract` — Security review
-- `midnight:explain-concept` — Learn Midnight concepts
-- `midnight:compare-approaches` — Compare implementation approaches
-- `midnight:debug-contract` — Debug issues
+| Category          | Repositories                                                                                                                                       |
+| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Core              | `compact`, `midnight-js`, `midnight-wallet`, `midnight-docs`                                                                                       |
+| Examples          | `example-counter`, `example-bboard`, `example-dex`, `create-mn-app`                                                                                |
+| Infrastructure    | `midnight-indexer`, `midnight-node-docker`, `midnight-dapp-connector-api`                                                                          |
+| Partner Libraries | `OpenZeppelin/compact-contracts`, `OpenZeppelin/midnight-apps`                                                                                     |
+| Official Partners | `bricktowers/midnight-seabattle`, `bricktowers/midnight-identity`, `bricktowers/midnight-rwa`, `MeshJS/midnight-starter-template`, `midnames/core` |
 
 ---
 
 ## Developer Setup
 
-For contributors:
-
 ```bash
-git clone https://github.com/Olanetsoft/midnight-mcp.git
-cd midnight-mcp
-npm install
-npm run build
-npm test
+git clone https://github.com/Olanetsoft/midnight-mcp.git && cd midnight-mcp
+npm install && npm run build && npm test
 ```
 
-### Testing with Local API
+<details>
+<summary><strong>API Backend & Local Development</strong></summary>
+
+The hosted API runs on Cloudflare Workers + Vectorize. See [api/README.md](./api/README.md).
 
-To test against a local API server instead of production:
+**Testing with Local API:**
 
 ```bash
 # Terminal 1: Start local API
-cd api
-npm install
-npm run dev  # Starts at http://localhost:8787
+cd api && npm install && npm run dev
 
 # Terminal 2: Run MCP with local API
 MIDNIGHT_API_URL=http://localhost:8787 npm start
 ```
 
-### API Backend
-
-The hosted API runs on Cloudflare Workers + Vectorize. See [api/README.md](./api/README.md) for deployment and development instructions.
-
-### Search Quality
-
-The API indexes **25 Midnight repositories** including core infrastructure, SDK, examples, ZK libraries, and developer tools.
-
-Search quality techniques:
+</details>
 
-- **Optimized chunking** — 1000-char chunks with 200-char overlap for precise, contextual results
-- **Hybrid search** — Combines vector similarity with keyword boosting (up to 20% boost for exact matches)
-- **Incremental indexing** — Daily updates via tarball download + batch embeddings (~5 min)
+## Links
 
-View live metrics at the [Dashboard](https://midnight-mcp-api.midnightmcp.workers.dev/dashboard).
+- [Midnight Docs](https://docs.midnight.network) • [MCP Spec](https://modelcontextprotocol.io) • [Midnight GitHub](https://github.com/midnightntwrk)
 
 ## License
 
 MIT
-
-## Links
-
-- [Midnight Docs](https://docs.midnight.network)
-- [MCP Spec](https://modelcontextprotocol.io)
-- [Midnight GitHub](https://github.com/midnightntwrk)

package/dist/tools/repository/constants.js

@@ -60,6 +60,24 @@ export const REPO_ALIASES = {
     "compact-contracts": { owner: "OpenZeppelin", repo: "compact-contracts" },
     openzeppelin: { owner: "OpenZeppelin", repo: "compact-contracts" },
     oz: { owner: "OpenZeppelin", repo: "compact-contracts" },
+    "midnight-apps": { owner: "OpenZeppelin", repo: "midnight-apps" },
+    lunarswap: { owner: "OpenZeppelin", repo: "midnight-apps" },
+    // Official Partners (from awesome-dapps)
+    "midnight-seabattle": { owner: "bricktowers", repo: "midnight-seabattle" },
+    seabattle: { owner: "bricktowers", repo: "midnight-seabattle" },
+    battleship: { owner: "bricktowers", repo: "midnight-seabattle" },
+    "midnight-identity": { owner: "bricktowers", repo: "midnight-identity" },
+    identity: { owner: "bricktowers", repo: "midnight-identity" },
+    "midnight-rwa": { owner: "bricktowers", repo: "midnight-rwa" },
+    rwa: { owner: "bricktowers", repo: "midnight-rwa" },
+    "midnight-starter-template": {
+        owner: "MeshJS",
+        repo: "midnight-starter-template",
+    },
+    meshjs: { owner: "MeshJS", repo: "midnight-starter-template" },
+    starter: { owner: "MeshJS", repo: "midnight-starter-template" },
+    midnames: { owner: "midnames", repo: "core" },
+    did: { owner: "midnames", repo: "core" },
 };
 export const EXAMPLES = [
     {

package/dist/tools/repository/handlers.js

@@ -141,8 +141,10 @@ export async function getLatestUpdates(input) {
  * Get version and release info for a repository
  */
 export async function getVersionInfo(input) {
-    logger.debug("Getting version info", input);
-    const resolved = resolveRepo(input.repo);
+    // Ensure repo defaults to compact if undefined/empty
+    const repoName = input?.repo || "compact";
+    logger.debug("Getting version info", { repo: repoName });
+    const resolved = resolveRepo(repoName);
     if (!resolved) {
         throw new Error(`Unknown repository: ${input.repo}. Available: ${Object.keys(REPO_ALIASES).join(", ")}`);
     }
@@ -170,10 +172,15 @@ export async function getVersionInfo(input) {
  * Check for breaking changes since a specific version
  */
 export async function checkBreakingChanges(input) {
-    logger.debug("Checking breaking changes", input);
-    const resolved = resolveRepo(input.repo);
+    // Ensure repo defaults to compact if undefined/empty
+    const repoName = input?.repo || "compact";
+    logger.debug("Checking breaking changes", {
+        repo: repoName,
+        currentVersion: input.currentVersion,
+    });
+    const resolved = resolveRepo(repoName);
     if (!resolved) {
-        throw new Error(`Unknown repository: ${input.repo}. Available: ${Object.keys(REPO_ALIASES).join(", ")}`);
+        throw new Error(`Unknown repository: ${repoName}. Available: ${Object.keys(REPO_ALIASES).join(", ")}`);
     }
     const outdatedInfo = await releaseTracker.isOutdated(resolved.owner, resolved.repo, input.currentVersion);
     const breakingChanges = await releaseTracker.getBreakingChangesSince(resolved.owner, resolved.repo, input.currentVersion);
@@ -196,10 +203,16 @@ export async function checkBreakingChanges(input) {
  * Get migration guide between versions
  */
 export async function getMigrationGuide(input) {
-    logger.debug("Getting migration guide", input);
-    const resolved = resolveRepo(input.repo);
+    // Ensure repo defaults to compact if undefined/empty
+    const repoName = input?.repo || "compact";
+    logger.debug("Getting migration guide", {
+        repo: repoName,
+        fromVersion: input.fromVersion,
+        toVersion: input.toVersion,
+    });
+    const resolved = resolveRepo(repoName);
     if (!resolved) {
-        throw new Error(`Unknown repository: ${input.repo}. Available: ${Object.keys(REPO_ALIASES).join(", ")}`);
+        throw new Error(`Unknown repository: ${repoName}. Available: ${Object.keys(REPO_ALIASES).join(", ")}`);
     }
     const guide = await releaseTracker.getMigrationGuide(resolved.owner, resolved.repo, input.fromVersion, input.toVersion);
     return {
@@ -226,14 +239,20 @@ export async function getMigrationGuide(input) {
  * Get a file at a specific version - critical for version-accurate recommendations
  */
 export async function getFileAtVersion(input) {
-    logger.debug("Getting file at version", input);
-    const resolved = resolveRepo(input.repo);
+    // Ensure repo defaults to compact if undefined/empty
+    const repoName = input?.repo || "compact";
+    logger.debug("Getting file at version", {
+        repo: repoName,
+        path: input.path,
+        version: input.version,
+    });
+    const resolved = resolveRepo(repoName);
     if (!resolved) {
-        throw new Error(`Unknown repository: ${input.repo}. Available: ${Object.keys(REPO_ALIASES).join(", ")}`);
+        throw new Error(`Unknown repository: ${repoName}. Available: ${Object.keys(REPO_ALIASES).join(", ")}`);
     }
     const result = await releaseTracker.getFileAtVersion(resolved.owner, resolved.repo, input.path, input.version);
     if (!result) {
-        throw new Error(`File not found: ${input.path} at version ${input.version} in ${input.repo}`);
+        throw new Error(`File not found: ${input.path} at version ${input.version} in ${repoName}`);
     }
     return {
         repository: `${resolved.owner}/${resolved.repo}`,
@@ -247,10 +266,16 @@ export async function getFileAtVersion(input) {
  * Compare syntax between two versions - shows what changed
  */
 export async function compareSyntax(input) {
-    logger.debug("Comparing syntax between versions", input);
-    const resolved = resolveRepo(input.repo);
+    // Ensure repo defaults to compact if undefined/empty
+    const repoName = input?.repo || "compact";
+    logger.debug("Comparing syntax between versions", {
+        repo: repoName,
+        oldVersion: input.oldVersion,
+        newVersion: input.newVersion,
+    });
+    const resolved = resolveRepo(repoName);
     if (!resolved) {
-        throw new Error(`Unknown repository: ${input.repo}. Available: ${Object.keys(REPO_ALIASES).join(", ")}`);
+        throw new Error(`Unknown repository: ${repoName}. Available: ${Object.keys(REPO_ALIASES).join(", ")}`);
     }
     // If no newVersion specified, get latest
     let newVersion = input.newVersion;
@@ -280,10 +305,12 @@ export async function compareSyntax(input) {
  * This is the source of truth for writing valid, compilable contracts
  */
 export async function getLatestSyntax(input) {
-    logger.debug("Getting latest syntax reference", input);
-    const resolved = resolveRepo(input.repo);
+    // Ensure repo defaults to compact if undefined/empty
+    const repoName = input?.repo || "compact";
+    logger.debug("Getting latest syntax reference", { repo: repoName });
+    const resolved = resolveRepo(repoName);
     if (!resolved) {
-        throw new Error(`Unknown repository: ${input.repo}. Available: ${Object.keys(REPO_ALIASES).join(", ")}`);
+        throw new Error(`Unknown repository: ${repoName}. Available: ${Object.keys(REPO_ALIASES).join(", ")}`);
     }
     const reference = await releaseTracker.getLatestSyntaxReference(resolved.owner, resolved.repo);
     if (!reference || reference.syntaxFiles.length === 0) {

package/dist/utils/config.js

@@ -173,7 +173,7 @@ export const DEFAULT_REPOSITORIES = [
         patterns: ["**/*.md"],
         exclude: [],
     },
-    // Partner Libraries
+    // Partner Libraries (OpenZeppelin)
     {
         owner: "OpenZeppelin",
         repo: "compact-contracts",
@@ -181,5 +181,48 @@ export const DEFAULT_REPOSITORIES = [
         patterns: ["**/*.compact", "**/*.ts", "**/*.md"],
         exclude: ["node_modules/**", "dist/**"],
     },
+    {
+        owner: "OpenZeppelin",
+        repo: "midnight-apps",
+        branch: "main",
+        patterns: ["**/*.compact", "**/*.ts", "**/*.md"],
+        exclude: ["node_modules/**", "dist/**"],
+    },
+    // Official Partners (from awesome-dapps)
+    {
+        owner: "bricktowers",
+        repo: "midnight-seabattle",
+        branch: "main",
+        patterns: ["**/*.compact", "**/*.ts", "**/*.md"],
+        exclude: ["node_modules/**", "dist/**"],
+    },
+    {
+        owner: "bricktowers",
+        repo: "midnight-identity",
+        branch: "main",
+        patterns: ["**/*.compact", "**/*.ts", "**/*.md"],
+        exclude: ["node_modules/**", "dist/**"],
+    },
+    {
+        owner: "bricktowers",
+        repo: "midnight-rwa",
+        branch: "main",
+        patterns: ["**/*.compact", "**/*.ts", "**/*.md"],
+        exclude: ["node_modules/**", "dist/**"],
+    },
+    {
+        owner: "MeshJS",
+        repo: "midnight-starter-template",
+        branch: "main",
+        patterns: ["**/*.compact", "**/*.ts", "**/*.md"],
+        exclude: ["node_modules/**", "dist/**"],
+    },
+    {
+        owner: "midnames",
+        repo: "core",
+        branch: "main",
+        patterns: ["**/*.compact", "**/*.ts", "**/*.md"],
+        exclude: ["node_modules/**", "dist/**"],
+    },
 ];
 //# sourceMappingURL=config.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "midnight-mcp",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "Model Context Protocol Server for Midnight Blockchain Development",
   "type": "module",
   "main": "dist/index.js",