@kjerneverk/riotplan 1.0.7-dev.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Tim O'Brien
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/MCP-ELICITATION-NOTES.md

@@ -0,0 +1,211 @@
+# MCP Elicitation Notes
+
+## Understanding MCP Elicitation
+
+### What It Is
+
+MCP elicitation (introduced in the 2025-06-18 specification) is a protocol feature that allows **servers** to request structured data from users dynamically during interactions. It uses JSON schemas to validate responses and enables interactive workflows.
+
+### How It Works
+
+Servers send `elicitation/create` requests to clients:
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "method": "elicitation/create",
+  "params": {
+    "message": "Please provide your GitHub username",
+    "requestedSchema": {
+      "type": "object",
+      "properties": {
+        "name": { "type": "string" }
+      },
+      "required": ["name"]
+    }
+  }
+}
+```
+
+Clients respond with:
+
+```json
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "result": {
+    "action": "accept",
+    "content": { "name": "octocat" }
+  }
+}
+```
+
+### Key Limitation for Prompts
+
+**Prompts cannot directly trigger elicitation requests.** Prompts are static text templates that return messages to inject into the conversation. They don't have the ability to make protocol-level requests.
+
+Only **tools** and **resources** can trigger elicitation by making `elicitation/create` requests during their execution.
+
+## Our Approach: Prompt Arguments + Model Instructions
+
+Since prompts can't trigger elicitation directly, we use a hybrid approach:
+
+### 1. Define Prompt Arguments
+
+```typescript
+{
+    name: 'create_plan',
+    description: 'Create a new plan with AI-generated steps for a complex task',
+    arguments: [
+        {
+            name: 'code',
+            description: 'Plan code/identifier',
+            required: false,
+        },
+        {
+            name: 'description',
+            description: 'Detailed description of what to accomplish',
+            required: false,
+        },
+        {
+            name: 'directory',
+            description: 'Parent directory where the plan should be created',
+            required: false,
+        },
+    ],
+}
+```
+
+### 2. Template Variable Substitution
+
+The prompt template uses `${code}`, `${description}`, etc.:
+
+```markdown
+## Step 1: Review Provided Information
+
+Check what information has already been provided:
+- **code**: ${code}
+- **description**: ${description}
+- **directory**: ${directory}
+```
+
+When arguments are missing, we substitute with markers like `[code]`, `[description]`:
+
+```typescript
+if (!filledArgs.code) filledArgs.code = '[code]';
+if (!filledArgs.description) filledArgs.description = '[description]';
+```
+
+### 3. Model Instructions
+
+The prompt explicitly tells the model to check for these markers:
+
+```markdown
+## Step 2: Gather Missing Information
+
+For any information marked as "[code]", "[description]", "[directory]", 
+ask the user to provide it:
+
+1. **Plan Code** (if missing) - Ask for a short identifier
+2. **Plan Description** (if missing) - Ask for a detailed description
+3. **Target Directory** (if missing) - Ask where to create the plan
+```
+
+## Benefits of This Approach
+
+### Client-Side Elicitation (Future)
+
+MCP clients could potentially:
+1. See that `create_plan` has arguments
+2. Elicit those arguments from the user BEFORE invoking the prompt
+3. Pass the collected values when calling the prompt
+
+This would provide a form-based UI for gathering information upfront.
+
+### Model-Side Fallback (Current)
+
+If the client doesn't elicit arguments:
+1. The prompt is invoked with missing arguments
+2. Template substitution marks them as `[code]`, `[description]`, etc.
+3. The model sees these markers and knows to ask the user
+4. The model uses natural language to gather information
+
+### Progressive Enhancement
+
+- Works today with explicit model instructions
+- Can be enhanced in the future if clients add argument elicitation
+- Provides clear structure for what information is needed
+
+## Alternative: Tool-Based Elicitation
+
+Another approach would be to create a tool that triggers elicitation:
+
+```typescript
+{
+    name: 'riotplan_elicit_plan_info',
+    description: 'Gather plan information from user',
+    inputSchema: {
+        type: 'object',
+        properties: {}
+    }
+}
+
+async function executeElicitPlanInfo(args, context) {
+    // Make elicitation/create request
+    const result = await context.elicit({
+        message: "Please provide plan information",
+        requestedSchema: {
+            type: "object",
+            properties: {
+                code: { type: "string", description: "Plan code" },
+                description: { type: "string", description: "What to accomplish" },
+                directory: { type: "string", description: "Where to create plan" }
+            },
+            required: ["code", "description"]
+        }
+    });
+    
+    return result;
+}
+```
+
+However, this has drawbacks:
+- Requires the model to know to call this tool
+- Adds an extra step (call tool, then call create)
+- Less integrated with the prompt workflow
+
+## Recommendation
+
+The **prompt arguments + model instructions** approach is the best solution because:
+
+1. **Works today** - Model instructions ensure it works immediately
+2. **Future-proof** - Can be enhanced if clients add argument elicitation
+3. **Clear structure** - Arguments document what's needed
+4. **Flexible** - Users can provide info upfront OR be prompted
+5. **Natural** - Model asks in conversational way, not just forms
+
+## Implementation Status
+
+✅ Added prompt arguments to `create_plan`
+✅ Added template variable substitution
+✅ Added explicit model instructions
+✅ Rebuilt MCP server with changes
+⏳ Waiting for client support for argument elicitation (future enhancement)
+
+## Testing
+
+To test the current implementation:
+
+1. Invoke `create_plan` prompt without arguments
+2. Model should see `[code]`, `[description]`, `[directory]` markers
+3. Model should ask user for missing information
+4. Model should use `riotplan_create` tool with collected info
+
+To test future client elicitation (when supported):
+
+1. Client sees `create_plan` has arguments
+2. Client shows form to collect: code, description, directory
+3. Client invokes prompt with collected values
+4. Model sees actual values, not markers
+5. Model proceeds directly to creating the plan

package/MCP-EXPLORE-IDEA-FIX.md

@@ -0,0 +1,122 @@
+# Fix: explore_idea Command UX Issue
+
+## Problem
+
+The `explore_idea` MCP prompt had a workflow mismatch that created a confusing user experience:
+
+1. User invokes the prompt (via MCP or Cursor command)
+2. AI would immediately stop and ask for structured input:
+   - "Please provide a code/identifier"
+   - "Please provide an initial description"
+3. User had to provide these in a second interaction
+4. Only then would the AI create the idea and begin exploration
+
+This created a jarring, form-filling experience instead of a natural conversational flow.
+
+## Root Cause
+
+The MCP prompt file (`src/mcp/prompts/explore_idea.md`) had outdated instructions that told the AI to:
+1. Ask the user for code and description
+2. Wait for response
+3. Then create the idea
+
+Meanwhile, the Cursor command version (`.cursor/commands/explore_idea.md`) had already been updated with smart extraction logic.
+
+## Solution
+
+Updated the MCP prompt to match the improved Cursor command version with smart extraction:
+
+### Key Changes
+
+1. **Smart Extraction First**: AI now checks if the user already provided code/description in their message
+2. **Derive Missing Info**: If description is provided but code is missing, AI derives a kebab-case code from the description
+3. **Natural Fallback**: Only asks for missing information if truly needed
+4. **Immediate Creation**: Creates the idea as soon as it has the required info
+5. **Start Exploration**: Begins the exploration conversation immediately after creation
+
+### Updated Workflow
+
+```
+1. Extract or Gather Idea Details
+   - Check user's message for code and description
+   - Extract if present
+   - Derive code from description if only description provided
+   - Only ask if both are missing
+
+2. Create the Idea
+   - Call riotplan_idea_create immediately with extracted/derived values
+
+3. Begin Exploration
+   - Start asking open-ended questions immediately
+   - Don't wait for further prompting
+```
+
+### Example Flows
+
+**Before Fix:**
+```
+User: /riotplan/explore_idea
+AI: "Please provide: 1. A short code/identifier 2. Initial description"
+User: "Ugh, okay... code is 'my-feature', description is 'Add feature X'"
+AI: *calls riotplan_idea_create*
+AI: "What's driving this?"
+```
+
+**After Fix - Full Info:**
+```
+User: /riotplan/explore_idea real-time-notifications Add push notifications
+AI: *extracts code="real-time-notifications", description="Add push notifications"*
+AI: *calls riotplan_idea_create immediately*
+AI: "Let's explore this idea. What's driving the need for push notifications?"
+```
+
+**After Fix - Partial Info:**
+```
+User: /riotplan/explore_idea I want to add notifications
+AI: *derives code="add-notifications", description="I want to add notifications"*
+AI: *calls riotplan_idea_create immediately*
+AI: "Let's explore this notification idea. What's driving this?"
+```
+
+**After Fix - No Info:**
+```
+User: /riotplan/explore_idea
+AI: "What idea would you like to explore? Give me a short name and brief description."
+User: "I'm thinking about real-time notifications"
+AI: *extracts and creates immediately*
+AI: "Great! Let's explore this. What's driving the need?"
+```
+
+## Files Changed
+
+- `/Users/tobrien/gitw/kjerneverk/riotplan/src/mcp/prompts/explore_idea.md`
+  - Updated workflow section with smart extraction logic
+  - Added detailed examples showing extraction patterns
+  - Added anti-pattern: "Don't ask for information the user already provided"
+  - Added principle: "Smart Extraction: Use information the user already provided"
+
+## Testing
+
+- All existing tests pass (623 tests, 92.84% coverage)
+- No breaking changes to MCP tool schemas
+- Backward compatible with all existing workflows
+
+## Benefits
+
+1. **Better UX**: Natural conversational flow instead of form-filling
+2. **Fewer Steps**: Reduces interaction from 2-3 messages to 1
+3. **Smarter AI**: AI extracts and derives information intelligently
+4. **Consistent**: MCP prompt now matches Cursor command behavior
+5. **Flexible**: Still supports all three scenarios (full info, partial info, no info)
+
+## Related Work
+
+The Cursor command version (`.cursor/commands/explore_idea.md`) already had this smart extraction logic. This fix brings the MCP prompt in sync with that improved version.
+
+## Future Considerations
+
+This pattern could be applied to other interactive prompts/commands that currently ask for structured input upfront. Candidates to review:
+- `checkpoint_create` (asks for name and message)
+- Any other prompts that immediately request structured data
+
+The key insight: **Extract first, ask later**. If the user has already provided information in their message, use it instead of asking them to repeat it.

package/MCP-FIXES.md

@@ -0,0 +1,50 @@
+# MCP Implementation Fixes Needed
+
+## TypeScript Errors to Fix
+
+### 1. Plan.path -> Plan.metadata.path
+- Plan type doesn't have `path` property
+- Use `plan.metadata.path` instead
+
+### 2. PlanStep.file -> PlanStep.filename
+- PlanStep has `filename` not `file`
+
+### 3. PlanState property names
+- `lastCompleted` -> `lastCompletedStep`
+- `lastUpdated` -> `lastUpdatedAt`
+
+### 4. PlanMetadata property names
+- `created` -> `createdAt`
+
+### 5. Blocker[] and Issue[] types
+- StatusResource expects `string[]` but Plan has `Blocker[]` and `Issue[]`
+- Need to convert to strings or update types
+
+### 6. ValidateOptions
+- `fix` property doesn't exist
+- Need to check actual API
+
+### 7. CreatePlanResult
+- Doesn't have `steps` property
+- Check actual return type
+
+### 8. GenerationContext
+- Missing `planName` property
+- Need to provide it
+
+### 9. MCP Build Externals
+- Need to add execution provider packages to externals in build-mcp.js
+
+## Files to Update
+
+1. `src/mcp/resources/plan.ts` - Fix property names
+2. `src/mcp/resources/status.ts` - Fix property names and types
+3. `src/mcp/resources/step.ts` - Fix property names
+4. `src/mcp/resources/steps.ts` - Fix property names
+5. `src/mcp/tools/status.ts` - Fix property names
+6. `src/mcp/tools/step.ts` - Fix property names
+7. `src/mcp/tools/create.ts` - Fix return type handling
+8. `src/mcp/tools/generate.ts` - Fix GenerationContext
+9. `src/mcp/tools/validate.ts` - Fix options
+10. `src/mcp/types.ts` - Update StatusResource type
+11. `scripts/build-mcp.js` - Add externals