@veloxts/mcp 0.6.25 → 0.6.27

package/CHANGELOG.md

@@ -0,0 +1,284 @@
+# @veloxts/mcp
+
+## 0.6.27
+
+### Patch Changes
+
+- chore: add GUIDE, LICENSE and CHANGELOG.md to npm files
+- Updated dependencies
+  - @veloxts/cli@0.6.27
+  - @veloxts/router@0.6.27
+  - @veloxts/validation@0.6.27
+
+## 0.6.26
+
+### Patch Changes
+
+- docs(mcp): add README and GUIDE, docs(web): simplify README and create concise GUIDE
+- Updated dependencies
+  - @veloxts/cli@0.6.26
+  - @veloxts/router@0.6.26
+  - @veloxts/validation@0.6.26
+
+## 0.6.25
+
+### Patch Changes
+
+- docs(create): add guide for React Server Components setup
+- Updated dependencies
+  - @veloxts/cli@0.6.25
+  - @veloxts/router@0.6.25
+  - @veloxts/validation@0.6.25
+
+## 0.6.24
+
+### Patch Changes
+
+- clarify installation paths and package contents
+- Updated dependencies
+  - @veloxts/cli@0.6.24
+  - @veloxts/router@0.6.24
+  - @veloxts/validation@0.6.24
+
+## 0.6.23
+
+### Patch Changes
+
+- add defineContract for improved type inference DX
+- Updated dependencies
+  - @veloxts/cli@0.6.23
+  - @veloxts/router@0.6.23
+  - @veloxts/validation@0.6.23
+
+## 0.6.22
+
+### Patch Changes
+
+- support {method, path} route entry format
+- Updated dependencies
+  - @veloxts/cli@0.6.22
+  - @veloxts/router@0.6.22
+  - @veloxts/validation@0.6.22
+
+## 0.6.21
+
+### Patch Changes
+
+- separate schemas from procedures for browser-safe import
+- Updated dependencies
+  - @veloxts/cli@0.6.21
+  - @veloxts/router@0.6.21
+  - @veloxts/validation@0.6.21
+
+## 0.6.20
+
+### Patch Changes
+
+- add Fastify ecosystem stubs and debuglog to util
+- Updated dependencies
+  - @veloxts/cli@0.6.20
+  - @veloxts/router@0.6.20
+  - @veloxts/validation@0.6.20
+
+## 0.6.19
+
+### Patch Changes
+
+- restore dotenv stub for browser compatibility
+- Updated dependencies
+  - @veloxts/cli@0.6.19
+  - @veloxts/router@0.6.19
+  - @veloxts/validation@0.6.19
+
+## 0.6.18
+
+### Patch Changes
+
+- add node:fs/promises stub and fix esbuild plugin
+- Updated dependencies
+  - @veloxts/cli@0.6.18
+  - @veloxts/router@0.6.18
+  - @veloxts/validation@0.6.18
+
+## 0.6.17
+
+### Patch Changes
+
+- remove optimizeDeps.exclude to fix CJS/ESM interop
+- Updated dependencies
+  - @veloxts/cli@0.6.17
+  - @veloxts/router@0.6.17
+  - @veloxts/validation@0.6.17
+
+## 0.6.16
+
+### Patch Changes
+
+- add stubs for Fastify ecosystem packages
+- Updated dependencies
+  - @veloxts/cli@0.6.16
+  - @veloxts/router@0.6.16
+  - @veloxts/validation@0.6.16
+
+## 0.6.15
+
+### Patch Changes
+
+- implement three-layer Node.js stubbing for Vite
+- Updated dependencies
+  - @veloxts/cli@0.6.15
+  - @veloxts/router@0.6.15
+  - @veloxts/validation@0.6.15
+
+## 0.6.14
+
+### Patch Changes
+
+- stub dotenv as virtual module instead of process shims
+- Updated dependencies
+  - @veloxts/cli@0.6.14
+  - @veloxts/router@0.6.14
+  - @veloxts/validation@0.6.14
+
+## 0.6.13
+
+### Patch Changes
+
+- add process.argv stub for dotenv browser compatibility
+- Updated dependencies
+  - @veloxts/cli@0.6.13
+  - @veloxts/router@0.6.13
+  - @veloxts/validation@0.6.13
+
+## 0.6.12
+
+### Patch Changes
+
+- Fixes the "process is not defined" error from dotenv
+- Updated dependencies
+  - @veloxts/cli@0.6.12
+  - @veloxts/router@0.6.12
+  - @veloxts/validation@0.6.12
+
+## 0.6.11
+
+### Patch Changes
+
+- add Vite plugin for Node.js module stubs
+- Updated dependencies
+  - @veloxts/cli@0.6.11
+  - @veloxts/router@0.6.11
+  - @veloxts/validation@0.6.11
+
+## 0.6.10
+
+### Patch Changes
+
+- use import() type syntax for AppRouter
+- Updated dependencies
+  - @veloxts/cli@0.6.10
+  - @veloxts/router@0.6.10
+  - @veloxts/validation@0.6.10
+
+## 0.6.9
+
+### Patch Changes
+
+- isolate auth procedures from database imports
+- Updated dependencies
+  - @veloxts/cli@0.6.9
+  - @veloxts/router@0.6.9
+  - @veloxts/validation@0.6.9
+
+## 0.6.8
+
+### Patch Changes
+
+- prevent dotenv from leaking into browser bundle
+- Updated dependencies
+  - @veloxts/cli@0.6.8
+  - @veloxts/router@0.6.8
+  - @veloxts/validation@0.6.8
+
+## 0.6.7
+
+### Patch Changes
+
+- better-sqlite3 versions mismatch fix
+- Updated dependencies
+  - @veloxts/cli@0.6.7
+  - @veloxts/router@0.6.7
+  - @veloxts/validation@0.6.7
+
+## 0.6.6
+
+### Patch Changes
+
+- ensure the web app never imports server-side code paths
+- Updated dependencies
+  - @veloxts/cli@0.6.6
+  - @veloxts/router@0.6.6
+  - @veloxts/validation@0.6.6
+
+## 0.6.5
+
+### Patch Changes
+
+- move @prisma/client-runtime-utils to root package.json
+- Updated dependencies
+  - @veloxts/cli@0.6.5
+  - @veloxts/router@0.6.5
+  - @veloxts/validation@0.6.5
+
+## 0.6.4
+
+### Patch Changes
+
+- add @prisma/client-runtime-utils dependency
+- Updated dependencies
+  - @veloxts/cli@0.6.4
+  - @veloxts/router@0.6.4
+  - @veloxts/validation@0.6.4
+
+## 0.6.3
+
+### Patch Changes
+
+- Add workspaces field to root package.json template + Fix Prisma ESM/CJS import for Node.js v24
+- Updated dependencies
+  - @veloxts/cli@0.6.3
+  - @veloxts/router@0.6.3
+  - @veloxts/validation@0.6.3
+
+## 0.6.2
+
+### Patch Changes
+
+- add server actions, removed some deprecated and other chore
+- Updated dependencies
+  - @veloxts/cli@0.6.2
+  - @veloxts/router@0.6.2
+  - @veloxts/validation@0.6.2
+
+## 0.6.1
+
+### Patch Changes
+
+- route groups for file-based routing; add dynamic route support with [param] segments
+- Updated dependencies
+  - @veloxts/cli@0.6.1
+  - @veloxts/router@0.6.1
+  - @veloxts/validation@0.6.1
+
+## 0.6.0
+
+### Minor Changes
+
+- RSC streaming, dynamic routes, Vinxi integration
+
+### Patch Changes
+
+- Updated dependencies
+  - @veloxts/cli@0.6.0
+  - @veloxts/router@0.6.0
+  - @veloxts/validation@0.6.0

package/GUIDE.md

@@ -0,0 +1,96 @@
+# MCP Server Guide
+
+The **@veloxts/mcp** package provides a Model Context Protocol (MCP) server that exposes your VeloxTS project structure to AI assistants. This enables intelligent code assistance with full awareness of your procedures, schemas, routes, and error codes.
+
+## What is MCP?
+
+Model Context Protocol is an open standard that enables AI assistants to access contextual information from your development environment. The VeloxTS MCP server allows Claude and other MCP-compatible AI tools to introspect your API structure programmatically.
+
+## Installation
+
+```bash
+npm install @veloxts/mcp
+```
+
+## Quick Start
+
+### CLI Usage
+
+Run the MCP server as a standalone process:
+
+```bash
+# Run MCP server with stdio transport
+velox-mcp
+
+# Enable debug logging
+velox-mcp --debug
+```
+
+### Programmatic Usage
+
+```typescript
+import { runMCPServer, createVeloxMCPServer } from '@veloxts/mcp';
+
+// Run with stdio transport (for CLI integration)
+await runMCPServer({ debug: true });
+
+// Or create a custom server instance
+const server = createVeloxMCPServer({
+  projectRoot: '/path/to/project',
+  debug: true,
+});
+```
+
+## Available Resources
+
+The MCP server exposes these read-only resources via `velox://` URIs:
+
+**velox://procedures** - Lists all registered procedures with types, inputs, outputs, and REST route mappings
+
+**velox://routes** - Shows REST route mappings generated from procedure naming conventions
+
+**velox://schemas** - Displays all Zod validation schemas defined in your project
+
+**velox://errors** - Error catalog with VeloxTS error codes, messages, and fix suggestions
+
+**velox://project** - Project metadata including paths to procedures, schemas, and Prisma schema
+
+## Available Tools
+
+AI assistants can invoke these actions:
+
+**velox_generate** - Generate VeloxTS code (procedures, schemas, resources, migrations, tests, etc.)
+
+**velox_migrate** - Run database migrations (status, run, rollback, fresh, reset)
+
+## Available Prompts
+
+Reusable prompt templates for common VeloxTS tasks:
+
+- **CREATE_PROCEDURE** - Guidance for creating type-safe API procedures
+- **SETUP_AUTH** - Instructions for implementing authentication
+- **ADD_VALIDATION** - Best practices for Zod schema validation
+- **ERROR_HANDLING** - Error handling patterns with typed responses
+
+## Claude Desktop Integration
+
+Add to your Claude Desktop configuration (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
+
+```json
+{
+  "mcpServers": {
+    "veloxts": {
+      "command": "velox-mcp",
+      "args": []
+    }
+  }
+}
+```
+
+Restart Claude Desktop. The VeloxTS context will be available when working in VeloxTS projects.
+
+## Learn More
+
+- **Main Package**: [@veloxts/velox](https://www.npmjs.com/package/@veloxts/velox)
+- **Framework Docs**: [VeloxTS Documentation](https://github.com/veloxts/velox-ts-framework)
+- **MCP Specification**: [Model Context Protocol](https://modelcontextprotocol.io)

package/README.md

@@ -0,0 +1,9 @@
+# @veloxts/mcp
+
+> **Early Preview (v0.6.x)** - APIs are stabilizing but may still change.
+
+Model Context Protocol server for VeloxTS - exposes project context (procedures, schemas, routes, errors) to AI assistants like Claude for intelligent code assistance. Learn more at [@veloxts/velox](https://www.npmjs.com/package/@veloxts/velox).
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@veloxts/mcp",
-  "version": "0.6.25",
+  "version": "0.6.27",
   "description": "Model Context Protocol server for VeloxTS - expose project context to AI tools",
   "type": "module",
   "main": "dist/index.js",
@@ -16,13 +16,16 @@
   },
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "GUIDE.md",
+    "LICENSE",
+    "CHANGELOG.md"
   ],
   "dependencies": {
     "@modelcontextprotocol/sdk": "1.25.1",
-    "@veloxts/validation": "0.6.25",
-    "@veloxts/cli": "0.6.25",
-    "@veloxts/router": "0.6.25"
+    "@veloxts/cli": "0.6.27",
+    "@veloxts/validation": "0.6.27",
+    "@veloxts/router": "0.6.27"
   },
   "peerDependencies": {
     "zod": ">=3.25.0"