@veloxts/mcp 0.6.52 → 0.6.54

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +103 -1
  3. package/package.json +4 -4
package/CHANGELOG.md CHANGED
@@ -1,5 +1,25 @@
1
1
  # @veloxts/mcp
2
2
 
3
+ ## 0.6.54
4
+
5
+ ### Patch Changes
6
+
7
+ - feat(cli): add velox mcp init command for Claude Desktop setup
8
+ - Updated dependencies
9
+ - @veloxts/cli@0.6.54
10
+ - @veloxts/router@0.6.54
11
+ - @veloxts/validation@0.6.54
12
+
13
+ ## 0.6.53
14
+
15
+ ### Patch Changes
16
+
17
+ - feat(cli): add duplicate file detection to resource generator
18
+ - Updated dependencies
19
+ - @veloxts/cli@0.6.53
20
+ - @veloxts/router@0.6.53
21
+ - @veloxts/validation@0.6.53
22
+
3
23
  ## 0.6.52
4
24
 
5
25
  ### Patch Changes
package/README.md CHANGED
@@ -2,7 +2,109 @@
2
2
 
3
3
  > **Early Preview (v0.6.x)** - APIs are stabilizing but may still change.
4
4
 
5
- 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).
5
+ Model Context Protocol server for VeloxTS - exposes project context (procedures, schemas, routes, errors) to AI assistants like Claude Desktop and other tools that support the Model Context Protocol.
6
+
7
+ ## Quick Start
8
+
9
+ ### Automatic Setup (Recommended)
10
+
11
+ The easiest way to set up the MCP server is using the VeloxTS CLI:
12
+
13
+ ```bash
14
+ velox mcp init
15
+ ```
16
+
17
+ This command will:
18
+ - Detect your operating system
19
+ - Locate your Claude Desktop configuration
20
+ - Add the VeloxTS MCP server configuration
21
+ - Guide you through the setup process
22
+
23
+ After running the command, **restart Claude Desktop** to activate the integration.
24
+
25
+ ### Manual Setup
26
+
27
+ If you prefer to configure manually, add this to your Claude Desktop configuration:
28
+
29
+ **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
30
+
31
+ **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
32
+
33
+ **Linux:** `~/.config/Claude/claude_desktop_config.json`
34
+
35
+ ```json
36
+ {
37
+ "mcpServers": {
38
+ "veloxts": {
39
+ "command": "npx",
40
+ "args": ["@veloxts/mcp"]
41
+ }
42
+ }
43
+ }
44
+ ```
45
+
46
+ ## What It Does
47
+
48
+ The MCP server provides Claude Desktop with deep context about your VeloxTS project:
49
+
50
+ - **Procedures**: All API procedures with their inputs, outputs, and business logic
51
+ - **Schemas**: Zod validation schemas and type definitions
52
+ - **Routes**: REST endpoints and tRPC procedure mappings
53
+ - **Errors**: Custom error types and error handling patterns
54
+ - **Project Structure**: File organization and module boundaries
55
+
56
+ This enables Claude to:
57
+ - Suggest code that matches your existing patterns
58
+ - Understand your API surface and data models
59
+ - Generate procedures that fit seamlessly with your codebase
60
+ - Help debug issues with full context of your project
61
+
62
+ ## CLI Commands
63
+
64
+ ### velox mcp init
65
+
66
+ Set up Claude Desktop configuration automatically:
67
+
68
+ ```bash
69
+ velox mcp init # Interactive setup
70
+ velox mcp init --dry-run # Preview changes without writing
71
+ velox mcp init --force # Overwrite existing configuration
72
+ velox mcp init --json # Output as JSON for scripting
73
+ ```
74
+
75
+ Options:
76
+ - `--dry-run, -d`: Preview configuration changes without writing files
77
+ - `--force, -f`: Overwrite existing VeloxTS MCP configuration
78
+ - `--json`: Output results as JSON for automated workflows
79
+
80
+ ## Troubleshooting
81
+
82
+ ### Claude Desktop doesn't show VeloxTS context
83
+
84
+ 1. Ensure you've restarted Claude Desktop after running `velox mcp init`
85
+ 2. Check that the configuration file exists and is valid JSON
86
+ 3. Verify `@veloxts/mcp` is installed in your project or globally accessible
87
+ 4. Try running `npx @veloxts/mcp` manually to test the server
88
+
89
+ ### Configuration file not found
90
+
91
+ Run `velox mcp init --dry-run` to see the expected configuration path for your platform. If Claude Desktop is not installed, the command will warn you.
92
+
93
+ ### Permission errors
94
+
95
+ On macOS/Linux, ensure you have write access to the configuration directory:
96
+
97
+ ```bash
98
+ # Check permissions
99
+ ls -la ~/Library/Application\ Support/Claude # macOS
100
+ ls -la ~/.config/Claude # Linux
101
+ ```
102
+
103
+ ## Learn More
104
+
105
+ - [Model Context Protocol](https://modelcontextprotocol.io) - Official MCP specification
106
+ - [@veloxts/cli](https://www.npmjs.com/package/@veloxts/cli) - VeloxTS CLI tools
107
+ - [@veloxts/velox](https://www.npmjs.com/package/@veloxts/velox) - Complete VeloxTS framework
6
108
 
7
109
  ## License
8
110
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veloxts/mcp",
3
- "version": "0.6.52",
3
+ "version": "0.6.54",
4
4
  "description": "Model Context Protocol server for VeloxTS - expose project context to AI tools",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -23,9 +23,9 @@
23
23
  ],
24
24
  "dependencies": {
25
25
  "@modelcontextprotocol/sdk": "1.25.1",
26
- "@veloxts/cli": "0.6.52",
27
- "@veloxts/validation": "0.6.52",
28
- "@veloxts/router": "0.6.52"
26
+ "@veloxts/cli": "0.6.54",
27
+ "@veloxts/router": "0.6.54",
28
+ "@veloxts/validation": "0.6.54"
29
29
  },
30
30
  "peerDependencies": {
31
31
  "zod": ">=3.25.0"