@devpad/mcp 1.0.1

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/README.md +107 -0
  2. package/dist/index.js +14961 -0
  3. package/package.json +61 -0
package/README.md ADDED
@@ -0,0 +1,107 @@
1
+ # @devpad/mcp
2
+
3
+ MCP (Model Context Protocol) server for devpad - exposes devpad API functionality for AI assistants like Claude.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install -g @devpad/mcp
9
+ # or
10
+ bunx @devpad/mcp
11
+ ```
12
+
13
+ ## Usage
14
+
15
+ ### Environment Variables
16
+
17
+ - `DEVPAD_API_KEY` (required): Your devpad API key from https://devpad.tools/account
18
+ - `DEVPAD_BASE_URL` (optional): Base URL for devpad API (defaults to https://devpad.tools/api/v0)
19
+
20
+ ### Claude Desktop Configuration
21
+
22
+ Add this to your Claude Desktop configuration file (`~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
23
+
24
+ ```json
25
+ {
26
+ "mcpServers": {
27
+ "devpad": {
28
+ "command": "bunx",
29
+ "args": ["@devpad/mcp"],
30
+ "env": {
31
+ "DEVPAD_API_KEY": "your-api-key-here"
32
+ }
33
+ }
34
+ }
35
+ }
36
+ ```
37
+
38
+ Or if you have the package installed locally:
39
+
40
+ ```json
41
+ {
42
+ "mcpServers": {
43
+ "devpad": {
44
+ "command": "node",
45
+ "args": ["path/to/devpad/packages/mcp/dist/index.js"],
46
+ "env": {
47
+ "DEVPAD_API_KEY": "your-api-key-here"
48
+ }
49
+ }
50
+ }
51
+ }
52
+ ```
53
+
54
+ ## Available Tools
55
+
56
+ The MCP server exposes all devpad API functionality as tools:
57
+
58
+ ### Projects
59
+ - `devpad_projects_list` - List all projects
60
+ - `devpad_projects_create` - Create a new project
61
+ - `devpad_projects_get` - Get project by ID or name
62
+ - `devpad_projects_update` - Update an existing project
63
+
64
+ ### Tasks
65
+ - `devpad_tasks_list` - List tasks (with optional filters)
66
+ - `devpad_tasks_create` - Create a new task
67
+ - `devpad_tasks_update` - Update an existing task
68
+ - `devpad_tasks_get` - Get task by ID
69
+
70
+ ### Milestones
71
+ - `devpad_milestones_list` - List milestones
72
+ - `devpad_milestones_create` - Create a new milestone
73
+ - `devpad_milestones_update` - Update an existing milestone
74
+
75
+ ### Goals
76
+ - `devpad_goals_list` - List goals
77
+ - `devpad_goals_create` - Create a new goal
78
+
79
+ ### Tags
80
+ - `devpad_tags_list` - List tags
81
+
82
+ ### GitHub Integration
83
+ - `devpad_github_repos` - List GitHub repositories
84
+ - `devpad_github_branches` - List branches for a repository
85
+
86
+ ## Example Usage in Claude
87
+
88
+ Once configured, you can use natural language in Claude:
89
+
90
+ - "List my devpad projects"
91
+ - "Create a new project called 'My App' with description 'A cool new app'"
92
+ - "Show me all tasks for project XYZ"
93
+ - "Create a milestone for Q1 2024"
94
+ - "What are my current goals?"
95
+
96
+ ## Development
97
+
98
+ ```bash
99
+ # Install dependencies
100
+ bun install
101
+
102
+ # Build
103
+ bun run build
104
+
105
+ # Run locally for testing
106
+ DEVPAD_API_KEY=your-key bun run dev
107
+ ```