@vibescope/mcp-server 0.2.8 → 0.3.0

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 (97) hide show
  1. package/CHANGELOG.md +84 -84
  2. package/README.md +194 -194
  3. package/dist/api-client.d.ts +41 -5
  4. package/dist/api-client.js +34 -0
  5. package/dist/cli.d.ts +1 -1
  6. package/dist/cli.js +30 -38
  7. package/dist/handlers/discovery.js +2 -0
  8. package/dist/handlers/roles.js +1 -8
  9. package/dist/handlers/session.d.ts +11 -0
  10. package/dist/handlers/session.js +124 -32
  11. package/dist/handlers/tasks.d.ts +8 -0
  12. package/dist/handlers/tasks.js +163 -3
  13. package/dist/handlers/tool-docs.js +840 -828
  14. package/dist/handlers/validation.js +71 -15
  15. package/dist/index.js +73 -73
  16. package/dist/setup.js +6 -6
  17. package/dist/templates/agent-guidelines.js +185 -185
  18. package/dist/templates/help-content.d.ts +24 -0
  19. package/dist/templates/help-content.js +1728 -0
  20. package/dist/tools.js +132 -87
  21. package/dist/utils.d.ts +15 -11
  22. package/dist/utils.js +53 -28
  23. package/docs/TOOLS.md +2406 -2053
  24. package/package.json +1 -1
  25. package/scripts/generate-docs.ts +212 -212
  26. package/scripts/version-bump.ts +203 -203
  27. package/src/api-client.test.ts +723 -723
  28. package/src/api-client.ts +2561 -2499
  29. package/src/cli.test.ts +24 -8
  30. package/src/cli.ts +204 -212
  31. package/src/handlers/__test-setup__.ts +236 -236
  32. package/src/handlers/__test-utils__.ts +87 -87
  33. package/src/handlers/blockers.test.ts +468 -468
  34. package/src/handlers/blockers.ts +163 -163
  35. package/src/handlers/bodies-of-work.test.ts +704 -704
  36. package/src/handlers/bodies-of-work.ts +526 -526
  37. package/src/handlers/connectors.test.ts +834 -834
  38. package/src/handlers/connectors.ts +229 -229
  39. package/src/handlers/cost.test.ts +462 -462
  40. package/src/handlers/cost.ts +285 -285
  41. package/src/handlers/decisions.test.ts +382 -382
  42. package/src/handlers/decisions.ts +153 -153
  43. package/src/handlers/deployment.test.ts +551 -551
  44. package/src/handlers/deployment.ts +541 -541
  45. package/src/handlers/discovery.test.ts +206 -206
  46. package/src/handlers/discovery.ts +392 -390
  47. package/src/handlers/fallback.test.ts +537 -537
  48. package/src/handlers/fallback.ts +194 -194
  49. package/src/handlers/file-checkouts.test.ts +750 -750
  50. package/src/handlers/file-checkouts.ts +185 -185
  51. package/src/handlers/findings.test.ts +633 -633
  52. package/src/handlers/findings.ts +239 -239
  53. package/src/handlers/git-issues.test.ts +631 -631
  54. package/src/handlers/git-issues.ts +136 -136
  55. package/src/handlers/ideas.test.ts +644 -644
  56. package/src/handlers/ideas.ts +207 -207
  57. package/src/handlers/index.ts +84 -84
  58. package/src/handlers/milestones.test.ts +475 -475
  59. package/src/handlers/milestones.ts +180 -180
  60. package/src/handlers/organizations.test.ts +826 -826
  61. package/src/handlers/organizations.ts +315 -315
  62. package/src/handlers/progress.test.ts +269 -269
  63. package/src/handlers/progress.ts +77 -77
  64. package/src/handlers/project.test.ts +546 -546
  65. package/src/handlers/project.ts +239 -239
  66. package/src/handlers/requests.test.ts +303 -303
  67. package/src/handlers/requests.ts +99 -99
  68. package/src/handlers/roles.test.ts +305 -303
  69. package/src/handlers/roles.ts +219 -226
  70. package/src/handlers/session.test.ts +998 -875
  71. package/src/handlers/session.ts +839 -738
  72. package/src/handlers/sprints.test.ts +732 -732
  73. package/src/handlers/sprints.ts +537 -537
  74. package/src/handlers/tasks.test.ts +931 -907
  75. package/src/handlers/tasks.ts +1121 -945
  76. package/src/handlers/tool-categories.test.ts +66 -66
  77. package/src/handlers/tool-docs.ts +1109 -1096
  78. package/src/handlers/types.test.ts +259 -259
  79. package/src/handlers/types.ts +175 -175
  80. package/src/handlers/validation.test.ts +582 -582
  81. package/src/handlers/validation.ts +159 -97
  82. package/src/index.test.ts +674 -0
  83. package/src/index.ts +792 -792
  84. package/src/setup.test.ts +233 -233
  85. package/src/setup.ts +404 -403
  86. package/src/templates/agent-guidelines.ts +210 -210
  87. package/src/templates/help-content.ts +1751 -0
  88. package/src/token-tracking.test.ts +463 -463
  89. package/src/token-tracking.ts +166 -166
  90. package/src/tools.test.ts +416 -0
  91. package/src/tools.ts +3607 -3562
  92. package/src/utils.test.ts +785 -683
  93. package/src/utils.ts +469 -436
  94. package/src/validators.test.ts +223 -223
  95. package/src/validators.ts +249 -249
  96. package/tsconfig.json +16 -16
  97. package/vitest.config.ts +14 -14
package/CHANGELOG.md CHANGED
@@ -1,84 +1,84 @@
1
- # Changelog
2
-
3
- All notable changes to `@vibescope/mcp-server` will be documented in this file.
4
-
5
- The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
- and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
-
8
- ## [Unreleased]
9
-
10
- ### Added
11
- - Test writing reminders in developer workflow - `update_task(status: "in_progress")` now includes test guidance
12
- - Test check in validation workflow - `claim_validation` now checks for test file modifications in PR
13
- - PR link display on completed tasks in dashboard
14
- - Smart task selection respecting sprints, bodies of work, phases and dependencies
15
- - `get_project_summary` endpoint for unified project overview
16
- - `get_file_checkouts_stats` endpoint for aggregate file lock statistics
17
- - Pagination support for `get_pending_requests`, `get_deployment_requirements`, `get_decisions`, `get_blockers`
18
- - Offset pagination for `get_git_issues`, `get_file_checkouts`, `get_activity_history`
19
- - Pagination for scheduled deployments, activity schedules, and stale worktrees
20
- - New project settings: `require_pr_for_validation`, `auto_merge_on_approval`, `validation_required`, `default_task_priority`, `require_time_estimates`, `fallback_activities_enabled`, `git_delete_branch_on_merge`
21
- - Stats endpoints for blockers and decisions
22
- - Automatic semantic version bumping script (`scripts/version-bump.ts`)
23
- - Version npm scripts: `version:check`, `version:bump`, `version:patch`, `version:minor`, `version:major`
24
-
25
- ### Changed
26
- - Worktree naming now includes agent persona and short task description for easier identification
27
- - Return `unanswered_questions_count` instead of full array in session responses for token efficiency
28
-
29
- ## [0.2.3] - 2026-01-14
30
-
31
- ### Fixed
32
- - Route complete_task through proxy endpoint for proper authentication
33
- - Surface unanswered questions prominently in start_work_session
34
-
35
- ### Changed
36
- - Improved session context type handling for completeTask
37
-
38
- ## [0.2.2] - 2026-01-13
39
-
40
- ### Added
41
- - Token tracking module with unit tests
42
- - Connector handlers with unit tests
43
- - Custom connectors support for external integrations
44
-
45
- ### Changed
46
- - Refactored duplicate tool definitions from index.ts
47
-
48
- ## [0.2.1] - 2026-01-12
49
-
50
- ### Added
51
- - Unit tests for blockers, decisions, and findings handlers
52
- - Stats endpoints for blockers, decisions, and findings
53
-
54
- ### Fixed
55
- - Security vulnerability in @modelcontextprotocol/sdk (GHSA-8r9q-7v3j-jr4g)
56
-
57
- ## [0.2.0] - 2026-01-11
58
-
59
- ### Added
60
- - Deployment priority feature - active deployments block regular task assignment
61
- - Background activity history and scheduling
62
- - Agent creator tracking for tasks, ideas, blockers, decisions
63
- - Setup CLI package for guided onboarding
64
-
65
- ### Changed
66
- - Updated get_next_task tool description to mention deployment blocking
67
- - Enhanced CLAUDE.md with deployment priority instructions
68
-
69
- ## [0.1.0] - 2026-01-10
70
-
71
- ### Added
72
- - Initial release of MCP server for Vibescope
73
- - Core tools: tasks, projects, sessions, progress tracking
74
- - Background activity support (fallback activities)
75
- - Git workflow integration with worktree support
76
- - Validation workflow for cross-agent task validation
77
- - Deployment coordination tools
78
-
79
- [Unreleased]: https://github.com/Nonatomic/Vibescope/compare/v0.2.3...HEAD
80
- [0.2.3]: https://github.com/Nonatomic/Vibescope/compare/v0.2.2...v0.2.3
81
- [0.2.2]: https://github.com/Nonatomic/Vibescope/compare/v0.2.1...v0.2.2
82
- [0.2.1]: https://github.com/Nonatomic/Vibescope/compare/v0.2.0...v0.2.1
83
- [0.2.0]: https://github.com/Nonatomic/Vibescope/compare/v0.1.0...v0.2.0
84
- [0.1.0]: https://github.com/Nonatomic/Vibescope/releases/tag/v0.1.0
1
+ # Changelog
2
+
3
+ All notable changes to `@vibescope/mcp-server` will be documented in this file.
4
+
5
+ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
+ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
+
8
+ ## [Unreleased]
9
+
10
+ ### Added
11
+ - Test writing reminders in developer workflow - `update_task(status: "in_progress")` now includes test guidance
12
+ - Test check in validation workflow - `claim_validation` now checks for test file modifications in PR
13
+ - PR link display on completed tasks in dashboard
14
+ - Smart task selection respecting sprints, bodies of work, phases and dependencies
15
+ - `get_project_summary` endpoint for unified project overview
16
+ - `get_file_checkouts_stats` endpoint for aggregate file lock statistics
17
+ - Pagination support for `get_pending_requests`, `get_deployment_requirements`, `get_decisions`, `get_blockers`
18
+ - Offset pagination for `get_git_issues`, `get_file_checkouts`, `get_activity_history`
19
+ - Pagination for scheduled deployments, activity schedules, and stale worktrees
20
+ - New project settings: `require_pr_for_validation`, `auto_merge_on_approval`, `validation_required`, `default_task_priority`, `require_time_estimates`, `fallback_activities_enabled`, `git_delete_branch_on_merge`
21
+ - Stats endpoints for blockers and decisions
22
+ - Automatic semantic version bumping script (`scripts/version-bump.ts`)
23
+ - Version npm scripts: `version:check`, `version:bump`, `version:patch`, `version:minor`, `version:major`
24
+
25
+ ### Changed
26
+ - Worktree naming now includes agent persona and short task description for easier identification
27
+ - Return `unanswered_questions_count` instead of full array in session responses for token efficiency
28
+
29
+ ## [0.2.3] - 2026-01-14
30
+
31
+ ### Fixed
32
+ - Route complete_task through proxy endpoint for proper authentication
33
+ - Surface unanswered questions prominently in start_work_session
34
+
35
+ ### Changed
36
+ - Improved session context type handling for completeTask
37
+
38
+ ## [0.2.2] - 2026-01-13
39
+
40
+ ### Added
41
+ - Token tracking module with unit tests
42
+ - Connector handlers with unit tests
43
+ - Custom connectors support for external integrations
44
+
45
+ ### Changed
46
+ - Refactored duplicate tool definitions from index.ts
47
+
48
+ ## [0.2.1] - 2026-01-12
49
+
50
+ ### Added
51
+ - Unit tests for blockers, decisions, and findings handlers
52
+ - Stats endpoints for blockers, decisions, and findings
53
+
54
+ ### Fixed
55
+ - Security vulnerability in @modelcontextprotocol/sdk (GHSA-8r9q-7v3j-jr4g)
56
+
57
+ ## [0.2.0] - 2026-01-11
58
+
59
+ ### Added
60
+ - Deployment priority feature - active deployments block regular task assignment
61
+ - Background activity history and scheduling
62
+ - Agent creator tracking for tasks, ideas, blockers, decisions
63
+ - Setup CLI package for guided onboarding
64
+
65
+ ### Changed
66
+ - Updated get_next_task tool description to mention deployment blocking
67
+ - Enhanced CLAUDE.md with deployment priority instructions
68
+
69
+ ## [0.1.0] - 2026-01-10
70
+
71
+ ### Added
72
+ - Initial release of MCP server for Vibescope
73
+ - Core tools: tasks, projects, sessions, progress tracking
74
+ - Background activity support (fallback activities)
75
+ - Git workflow integration with worktree support
76
+ - Validation workflow for cross-agent task validation
77
+ - Deployment coordination tools
78
+
79
+ [Unreleased]: https://github.com/Nonatomic/Vibescope/compare/v0.2.3...HEAD
80
+ [0.2.3]: https://github.com/Nonatomic/Vibescope/compare/v0.2.2...v0.2.3
81
+ [0.2.2]: https://github.com/Nonatomic/Vibescope/compare/v0.2.1...v0.2.2
82
+ [0.2.1]: https://github.com/Nonatomic/Vibescope/compare/v0.2.0...v0.2.1
83
+ [0.2.0]: https://github.com/Nonatomic/Vibescope/compare/v0.1.0...v0.2.0
84
+ [0.1.0]: https://github.com/Nonatomic/Vibescope/releases/tag/v0.1.0
package/README.md CHANGED
@@ -1,194 +1,194 @@
1
- # @vibescope/mcp-server
2
-
3
- MCP server for Vibescope - enables AI agents to track project progress, tasks, blockers, and decisions.
4
-
5
- ## Installation
6
-
7
- ### Option 1: npx (Recommended - No Installation)
8
-
9
- Use directly in your MCP config without installing:
10
-
11
- ```json
12
- {
13
- "mcpServers": {
14
- "vibescope": {
15
- "command": "npx",
16
- "args": ["-y", "-p", "@vibescope/mcp-server@latest", "vibescope-mcp"],
17
- "env": {
18
- "VIBESCOPE_API_KEY": "your-api-key"
19
- }
20
- }
21
- }
22
- }
23
- ```
24
-
25
- ### Option 2: Global Install
26
-
27
- ```bash
28
- npm install -g @vibescope/mcp-server@latest
29
- ```
30
-
31
- Then configure:
32
-
33
- ```json
34
- {
35
- "mcpServers": {
36
- "vibescope": {
37
- "command": "vibescope-mcp",
38
- "env": {
39
- "VIBESCOPE_API_KEY": "your-api-key"
40
- }
41
- }
42
- }
43
- }
44
- ```
45
-
46
- ## Quick Start
47
-
48
- ### Interactive Setup (Recommended)
49
-
50
- Run the setup wizard to automatically configure Vibescope for your IDE:
51
-
52
- ```bash
53
- npx -p @vibescope/mcp-server vibescope-cli setup
54
- ```
55
-
56
- This guides you through:
57
- 1. Selecting your IDE (Claude Code, Claude Desktop, Cursor, or Gemini CLI)
58
- 2. Getting your API key from the Vibescope dashboard
59
- 3. Writing the configuration file
60
-
61
- ### Claude Code (Manual)
62
-
63
- ```bash
64
- claude mcp add vibescope npx @vibescope/mcp-server@latest \
65
- --env VIBESCOPE_API_KEY=your_key
66
- ```
67
-
68
- ### Gemini CLI (Manual)
69
-
70
- Add to your `~/.gemini/settings.json` or project-level `.gemini/settings.json`:
71
-
72
- ```json
73
- {
74
- "mcpServers": {
75
- "vibescope": {
76
- "command": "npx",
77
- "args": ["-y", "-p", "@vibescope/mcp-server@latest", "vibescope-mcp"],
78
- "env": {
79
- "VIBESCOPE_API_KEY": "$VIBESCOPE_API_KEY"
80
- },
81
- "timeout": 30000,
82
- "trust": true
83
- }
84
- }
85
- }
86
- ```
87
-
88
- Then set your API key as an environment variable:
89
- ```bash
90
- export VIBESCOPE_API_KEY=your_key_here
91
- ```
92
-
93
- ## How to Call MCP Tools (Important for AI Agents)
94
-
95
- MCP tools are invoked **from within your AI conversation**, not via command line.
96
-
97
- **WRONG - CLI does not have a 'call' command:**
98
- ```bash
99
- # This does NOT work
100
- claude mcp call vibescope start_work_session '{"git_url": "..."}'
101
- ```
102
-
103
- **RIGHT - Call tools within your conversation response:**
104
- ```
105
- # Invoke as a tool call, same as Read, Edit, or Bash
106
- mcp__vibescope__start_work_session(git_url: "...", model: "opus")
107
- ```
108
-
109
- The CLI commands (`claude mcp`, `gemini mcp`) are only for **server configuration** (`add`, `remove`, `list`), not for calling tools. All tool invocations happen within the AI conversation context.
110
-
111
- ## Getting an API Key
112
-
113
- 1. Sign up at [vibescope.dev](https://vibescope.dev)
114
- 2. Go to Settings
115
- 3. Generate an API key
116
-
117
- ## Available Tools
118
-
119
- The MCP server provides **140+ tools** for AI agents. Here are the key tools by category:
120
-
121
- ### Session
122
- | Tool | Description |
123
- |------|-------------|
124
- | `start_work_session` | Initialize session, get persona, role, and next task |
125
- | `end_work_session` | End session and release claimed tasks |
126
- | `heartbeat` | Keep session active (call every 30-60s) |
127
- | `get_help` | Get guidance on workflows |
128
- | `discover_tools` | List tools by category |
129
- | `get_tool_info` | Get detailed tool documentation |
130
-
131
- ### Projects
132
- | Tool | Description |
133
- |------|-------------|
134
- | `create_project` | Create a new project |
135
- | `update_project` | Update project details and git workflow |
136
- | `get_project_context` | Get full project context |
137
- | `get_git_workflow` | Get git branching instructions |
138
- | `query_knowledge_base` | Query aggregated project knowledge |
139
-
140
- ### Tasks
141
- | Tool | Description |
142
- |------|-------------|
143
- | `get_tasks` | List tasks, optionally filtered by status |
144
- | `get_next_task` | Get highest priority pending task |
145
- | `add_task` | Create a new task |
146
- | `update_task` | Update task status, progress, or details |
147
- | `complete_task` | Mark a task as completed |
148
- | `add_subtask` | Break down tasks into subtasks |
149
- | `add_task_reference` | Add reference URL (docs, PRs) |
150
- | `batch_update_tasks` | Update multiple tasks at once |
151
-
152
- ### Progress & Context
153
- | Tool | Description |
154
- |------|-------------|
155
- | `log_progress` | Log a progress update |
156
- | `add_blocker` | Flag a blocker needing human input |
157
- | `resolve_blocker` | Mark a blocker as resolved |
158
- | `log_decision` | Record an architectural decision |
159
- | `add_idea` | Record an improvement idea |
160
- | `add_finding` | Record an audit finding |
161
-
162
- ### Validation & Deployment
163
- | Tool | Description |
164
- |------|-------------|
165
- | `get_tasks_awaiting_validation` | Get tasks needing review |
166
- | `claim_validation` | Claim a task for review |
167
- | `validate_task` | Approve or reject work |
168
- | `request_deployment` | Request a deployment |
169
- | `check_deployment_status` | Check deployment state |
170
- | `complete_deployment` | Mark deployment done |
171
-
172
- ### Collaboration
173
- | Tool | Description |
174
- |------|-------------|
175
- | `add_milestone` | Track progress on complex tasks |
176
- | `create_body_of_work` | Group tasks into phases |
177
- | `create_sprint` | Create time-bounded sprints |
178
- | `checkout_file` | Prevent file conflicts |
179
- | `get_pending_requests` | Get human requests |
180
- | `answer_question` | Answer user questions |
181
-
182
- ### Additional Categories
183
- - **Organizations**: Create, manage, and share projects with teams
184
- - **Cost Tracking**: Monitor spending with alerts and summaries
185
- - **Git Issues**: Track merge conflicts and push failures
186
- - **Role Management**: Configure agent roles (developer, validator, deployer)
187
- - **Scheduled Deployments**: Schedule recurring deployments
188
-
189
- Use `discover_tools` to explore all categories and `get_tool_info` for detailed documentation
190
-
191
- ## Rate Limits
192
-
193
- - 60 requests per minute per API key
194
- - Warning shown when quota drops below 10 requests
1
+ # @vibescope/mcp-server
2
+
3
+ MCP server for Vibescope - enables AI agents to track project progress, tasks, blockers, and decisions.
4
+
5
+ ## Installation
6
+
7
+ ### Option 1: npx (Recommended - No Installation)
8
+
9
+ Use directly in your MCP config without installing:
10
+
11
+ ```json
12
+ {
13
+ "mcpServers": {
14
+ "vibescope": {
15
+ "command": "npx",
16
+ "args": ["-y", "-p", "@vibescope/mcp-server@latest", "vibescope-mcp"],
17
+ "env": {
18
+ "VIBESCOPE_API_KEY": "your-api-key"
19
+ }
20
+ }
21
+ }
22
+ }
23
+ ```
24
+
25
+ ### Option 2: Global Install
26
+
27
+ ```bash
28
+ npm install -g @vibescope/mcp-server@latest
29
+ ```
30
+
31
+ Then configure:
32
+
33
+ ```json
34
+ {
35
+ "mcpServers": {
36
+ "vibescope": {
37
+ "command": "vibescope-mcp",
38
+ "env": {
39
+ "VIBESCOPE_API_KEY": "your-api-key"
40
+ }
41
+ }
42
+ }
43
+ }
44
+ ```
45
+
46
+ ## Quick Start
47
+
48
+ ### Interactive Setup (Recommended)
49
+
50
+ Run the setup wizard to automatically configure Vibescope for your IDE:
51
+
52
+ ```bash
53
+ npx -p @vibescope/mcp-server vibescope-cli setup
54
+ ```
55
+
56
+ This guides you through:
57
+ 1. Selecting your IDE (Claude Code, Claude Desktop, Cursor, or Gemini CLI)
58
+ 2. Getting your API key from the Vibescope dashboard
59
+ 3. Writing the configuration file
60
+
61
+ ### Claude Code (Manual)
62
+
63
+ ```bash
64
+ claude mcp add vibescope npx @vibescope/mcp-server@latest \
65
+ --env VIBESCOPE_API_KEY=your_key
66
+ ```
67
+
68
+ ### Gemini CLI (Manual)
69
+
70
+ Add to your `~/.gemini/settings.json` or project-level `.gemini/settings.json`:
71
+
72
+ ```json
73
+ {
74
+ "mcpServers": {
75
+ "vibescope": {
76
+ "command": "npx",
77
+ "args": ["-y", "-p", "@vibescope/mcp-server@latest", "vibescope-mcp"],
78
+ "env": {
79
+ "VIBESCOPE_API_KEY": "$VIBESCOPE_API_KEY"
80
+ },
81
+ "timeout": 30000,
82
+ "trust": true
83
+ }
84
+ }
85
+ }
86
+ ```
87
+
88
+ Then set your API key as an environment variable:
89
+ ```bash
90
+ export VIBESCOPE_API_KEY=your_key_here
91
+ ```
92
+
93
+ ## How to Call MCP Tools (Important for AI Agents)
94
+
95
+ MCP tools are invoked **from within your AI conversation**, not via command line.
96
+
97
+ **WRONG - CLI does not have a 'call' command:**
98
+ ```bash
99
+ # This does NOT work
100
+ claude mcp call vibescope start_work_session '{"git_url": "..."}'
101
+ ```
102
+
103
+ **RIGHT - Call tools within your conversation response:**
104
+ ```
105
+ # Invoke as a tool call, same as Read, Edit, or Bash
106
+ mcp__vibescope__start_work_session(git_url: "...", model: "opus")
107
+ ```
108
+
109
+ The CLI commands (`claude mcp`, `gemini mcp`) are only for **server configuration** (`add`, `remove`, `list`), not for calling tools. All tool invocations happen within the AI conversation context.
110
+
111
+ ## Getting an API Key
112
+
113
+ 1. Sign up at [vibescope.dev](https://vibescope.dev)
114
+ 2. Go to Settings
115
+ 3. Generate an API key
116
+
117
+ ## Available Tools
118
+
119
+ The MCP server provides **140+ tools** for AI agents. Here are the key tools by category:
120
+
121
+ ### Session
122
+ | Tool | Description |
123
+ |------|-------------|
124
+ | `start_work_session` | Initialize session, get persona, role, and next task |
125
+ | `end_work_session` | End session and release claimed tasks |
126
+ | `heartbeat` | Keep session active (call every 30-60s) |
127
+ | `get_help` | Get guidance on workflows |
128
+ | `discover_tools` | List tools by category |
129
+ | `get_tool_info` | Get detailed tool documentation |
130
+
131
+ ### Projects
132
+ | Tool | Description |
133
+ |------|-------------|
134
+ | `create_project` | Create a new project |
135
+ | `update_project` | Update project details and git workflow |
136
+ | `get_project_context` | Get full project context |
137
+ | `get_git_workflow` | Get git branching instructions |
138
+ | `query_knowledge_base` | Query aggregated project knowledge |
139
+
140
+ ### Tasks
141
+ | Tool | Description |
142
+ |------|-------------|
143
+ | `get_tasks` | List tasks, optionally filtered by status |
144
+ | `get_next_task` | Get highest priority pending task |
145
+ | `add_task` | Create a new task |
146
+ | `update_task` | Update task status, progress, or details |
147
+ | `complete_task` | Mark a task as completed |
148
+ | `add_subtask` | Break down tasks into subtasks |
149
+ | `add_task_reference` | Add reference URL (docs, PRs) |
150
+ | `batch_update_tasks` | Update multiple tasks at once |
151
+
152
+ ### Progress & Context
153
+ | Tool | Description |
154
+ |------|-------------|
155
+ | `log_progress` | Log a progress update |
156
+ | `add_blocker` | Flag a blocker needing human input |
157
+ | `resolve_blocker` | Mark a blocker as resolved |
158
+ | `log_decision` | Record an architectural decision |
159
+ | `add_idea` | Record an improvement idea |
160
+ | `add_finding` | Record an audit finding |
161
+
162
+ ### Validation & Deployment
163
+ | Tool | Description |
164
+ |------|-------------|
165
+ | `get_tasks_awaiting_validation` | Get tasks needing review |
166
+ | `claim_validation` | Claim a task for review |
167
+ | `validate_task` | Approve or reject work |
168
+ | `request_deployment` | Request a deployment |
169
+ | `check_deployment_status` | Check deployment state |
170
+ | `complete_deployment` | Mark deployment done |
171
+
172
+ ### Collaboration
173
+ | Tool | Description |
174
+ |------|-------------|
175
+ | `add_milestone` | Track progress on complex tasks |
176
+ | `create_body_of_work` | Group tasks into phases |
177
+ | `create_sprint` | Create time-bounded sprints |
178
+ | `checkout_file` | Prevent file conflicts |
179
+ | `get_pending_requests` | Get human requests |
180
+ | `answer_question` | Answer user questions |
181
+
182
+ ### Additional Categories
183
+ - **Organizations**: Create, manage, and share projects with teams
184
+ - **Cost Tracking**: Monitor spending with alerts and summaries
185
+ - **Git Issues**: Track merge conflicts and push failures
186
+ - **Role Management**: Configure agent roles (developer, validator, deployer)
187
+ - **Scheduled Deployments**: Schedule recurring deployments
188
+
189
+ Use `discover_tools` to explore all categories and `get_tool_info` for detailed documentation
190
+
191
+ ## Rate Limits
192
+
193
+ - 60 requests per minute per API key
194
+ - Warning shown when quota drops below 10 requests
@@ -29,10 +29,10 @@ export declare class VibescopeApiClient {
29
29
  project_id?: string;
30
30
  git_url?: string;
31
31
  mode?: 'lite' | 'full';
32
- model?: 'opus' | 'sonnet' | 'haiku';
33
- role?: 'developer' | 'validator' | 'deployer' | 'reviewer' | 'maintainer';
32
+ model?: string;
33
+ role?: string;
34
34
  hostname?: string;
35
- agent_type?: 'claude' | 'gemini' | 'cursor' | 'windsurf' | 'other';
35
+ agent_type?: string;
36
36
  }): Promise<ApiResponse<{
37
37
  session_started: boolean;
38
38
  session_id?: string;
@@ -142,6 +142,12 @@ export declare class VibescopeApiClient {
142
142
  };
143
143
  reminders?: string[];
144
144
  }>>;
145
+ signalIdle(sessionId: string): Promise<ApiResponse<{
146
+ success: boolean;
147
+ session_id: string;
148
+ status: string;
149
+ message: string;
150
+ }>>;
145
151
  listProjects(): Promise<ApiResponse<{
146
152
  projects: Array<{
147
153
  id: string;
@@ -479,6 +485,7 @@ export declare class VibescopeApiClient {
479
485
  validation?: number;
480
486
  blockers?: number;
481
487
  deployment?: string;
488
+ worktree_path?: string;
482
489
  };
483
490
  next_action: string;
484
491
  warnings?: string[];
@@ -487,6 +494,34 @@ export declare class VibescopeApiClient {
487
494
  success: boolean;
488
495
  deleted_id: string;
489
496
  }>>;
497
+ /**
498
+ * Release a task back to pending status.
499
+ * Clears session assignment, git branch, and worktree info.
500
+ */
501
+ releaseTask(taskId: string, params?: {
502
+ reason?: string;
503
+ session_id?: string;
504
+ }): Promise<ApiResponse<{
505
+ success: boolean;
506
+ task_id: string;
507
+ message: string;
508
+ reason?: string;
509
+ hint: string;
510
+ }>>;
511
+ /**
512
+ * Cancel a task with an optional reason.
513
+ * Task remains visible with cancelled status for historical tracking.
514
+ */
515
+ cancelTask(taskId: string, params?: {
516
+ cancelled_reason?: 'pr_closed' | 'superseded' | 'user_cancelled' | 'validation_failed' | 'obsolete' | 'blocked';
517
+ cancellation_note?: string;
518
+ session_id?: string;
519
+ }): Promise<ApiResponse<{
520
+ success: boolean;
521
+ task_id: string;
522
+ cancelled_reason: string | null;
523
+ message: string;
524
+ }>>;
490
525
  logProgress(projectId: string, params: {
491
526
  summary: string;
492
527
  details?: string;
@@ -760,6 +795,7 @@ export declare class VibescopeApiClient {
760
795
  approved: boolean;
761
796
  validation_notes?: string;
762
797
  skip_pr_check?: boolean;
798
+ pr_checks_passing?: boolean;
763
799
  }, sessionId?: string): Promise<ApiResponse<{
764
800
  success: boolean;
765
801
  approved: boolean;
@@ -970,7 +1006,7 @@ export declare class VibescopeApiClient {
970
1006
  reportTokenUsage(sessionId: string, params: {
971
1007
  input_tokens: number;
972
1008
  output_tokens: number;
973
- model?: 'opus' | 'sonnet' | 'haiku';
1009
+ model?: string;
974
1010
  }): Promise<ApiResponse<{
975
1011
  success: boolean;
976
1012
  reported: {
@@ -1676,7 +1712,7 @@ export declare class VibescopeApiClient {
1676
1712
  * Confirm that agent setup is complete for a project.
1677
1713
  * This marks the agent type as onboarded so future sessions don't receive setup instructions.
1678
1714
  */
1679
- confirmAgentSetup(projectId: string, agentType: 'claude' | 'gemini' | 'cursor' | 'windsurf' | 'other'): Promise<ApiResponse<{
1715
+ confirmAgentSetup(projectId: string, agentType: string): Promise<ApiResponse<{
1680
1716
  success: boolean;
1681
1717
  project_id: string;
1682
1718
  agent_type: string;