@groupby/ai-dev 0.2.1 → 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 (45) hide show
  1. package/README.md +3 -1
  2. package/dist/index.js +86 -19
  3. package/package.json +4 -4
  4. package/skills/library/implementation-plan/README.md +19 -0
  5. package/skills/library/implementation-plan/SKILL.md +337 -0
  6. package/skills/library/jira-plan/README.md +17 -0
  7. package/skills/library/jira-plan/SKILL.md +163 -0
  8. package/toolsets/rzlv-flow/README.md +54 -9
  9. package/toolsets/rzlv-flow/resources/confluence-file-structure.md +129 -23
  10. package/toolsets/rzlv-flow/resources/sync-state-format.md +109 -0
  11. package/toolsets/rzlv-flow/skills/jira-daily-triage/SKILL.md +13 -5
  12. package/toolsets/rzlv-flow/skills/jira-sprint-status/SKILL.md +28 -1
  13. package/toolsets/rzlv-flow/skills/jira-ticket-focus/SKILL.md +6 -1
  14. package/toolsets/rzlv-flow/skills/jira-wrap-sync/SKILL.md +41 -8
  15. package/skills/skills/README.md +0 -61
  16. package/skills/skills/archived/README.md +0 -3
  17. package/skills/skills/library/README.md +0 -3
  18. package/skills/skills/library/frontend-design/LICENSE.txt +0 -177
  19. package/skills/skills/library/frontend-design/SKILL.md +0 -42
  20. package/teams/teams/brain-studio/skills/code-review/SKILL.md +0 -46
  21. package/toolsets/toolsets/rzlv-flow/README.md +0 -102
  22. package/toolsets/toolsets/rzlv-flow/docs/mcp-setup.md +0 -126
  23. package/toolsets/toolsets/rzlv-flow/resources/README.md +0 -16
  24. package/toolsets/toolsets/rzlv-flow/resources/confluence-file-structure.md +0 -285
  25. package/toolsets/toolsets/rzlv-flow/resources/confluence-page-templates/README.md +0 -19
  26. package/toolsets/toolsets/rzlv-flow/resources/confluence-page-templates/decisions.md +0 -36
  27. package/toolsets/toolsets/rzlv-flow/resources/confluence-page-templates/initiative-overview.md +0 -40
  28. package/toolsets/toolsets/rzlv-flow/resources/confluence-page-templates/strategic-context.md +0 -44
  29. package/toolsets/toolsets/rzlv-flow/resources/confluence-page-templates/technical-architecture.md +0 -48
  30. package/toolsets/toolsets/rzlv-flow/resources/fcmp-protocol.md +0 -331
  31. package/toolsets/toolsets/rzlv-flow/resources/jira-file-structure.md +0 -177
  32. package/toolsets/toolsets/rzlv-flow/resources/sync-state-format.md +0 -318
  33. package/toolsets/toolsets/rzlv-flow/skills/atlassian-orchestrator/SKILL.md +0 -643
  34. package/toolsets/toolsets/rzlv-flow/skills/context-analyst/SKILL.md +0 -265
  35. package/toolsets/toolsets/rzlv-flow/skills/jira-comment/SKILL.md +0 -89
  36. package/toolsets/toolsets/rzlv-flow/skills/jira-daily-triage/SKILL.md +0 -143
  37. package/toolsets/toolsets/rzlv-flow/skills/jira-sprint-status/SKILL.md +0 -143
  38. package/toolsets/toolsets/rzlv-flow/skills/jira-status/SKILL.md +0 -97
  39. package/toolsets/toolsets/rzlv-flow/skills/jira-sync/SKILL.md +0 -148
  40. package/toolsets/toolsets/rzlv-flow/skills/jira-ticket-focus/SKILL.md +0 -245
  41. package/toolsets/toolsets/rzlv-flow/skills/jira-ticket-trace/SKILL.md +0 -112
  42. package/toolsets/toolsets/rzlv-flow/skills/jira-wrap-sync/SKILL.md +0 -260
  43. /package/toolsets/{toolsets/rzlv-flow → rzlv-flow}/docs/getting-started.md +0 -0
  44. /package/toolsets/{toolsets/rzlv-flow → rzlv-flow}/skills/confluence-fetch/SKILL.md +0 -0
  45. /package/toolsets/{toolsets/rzlv-flow → rzlv-flow}/skills/confluence-publish/SKILL.md +0 -0
@@ -1,177 +0,0 @@
1
-
2
- Apache License
3
- Version 2.0, January 2004
4
- http://www.apache.org/licenses/
5
-
6
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
-
8
- 1. Definitions.
9
-
10
- "License" shall mean the terms and conditions for use, reproduction,
11
- and distribution as defined by Sections 1 through 9 of this document.
12
-
13
- "Licensor" shall mean the copyright owner or entity authorized by
14
- the copyright owner that is granting the License.
15
-
16
- "Legal Entity" shall mean the union of the acting entity and all
17
- other entities that control, are controlled by, or are under common
18
- control with that entity. For the purposes of this definition,
19
- "control" means (i) the power, direct or indirect, to cause the
20
- direction or management of such entity, whether by contract or
21
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
- outstanding shares, or (iii) beneficial ownership of such entity.
23
-
24
- "You" (or "Your") shall mean an individual or Legal Entity
25
- exercising permissions granted by this License.
26
-
27
- "Source" form shall mean the preferred form for making modifications,
28
- including but not limited to software source code, documentation
29
- source, and configuration files.
30
-
31
- "Object" form shall mean any form resulting from mechanical
32
- transformation or translation of a Source form, including but
33
- not limited to compiled object code, generated documentation,
34
- and conversions to other media types.
35
-
36
- "Work" shall mean the work of authorship, whether in Source or
37
- Object form, made available under the License, as indicated by a
38
- copyright notice that is included in or attached to the work
39
- (an example is provided in the Appendix below).
40
-
41
- "Derivative Works" shall mean any work, whether in Source or Object
42
- form, that is based on (or derived from) the Work and for which the
43
- editorial revisions, annotations, elaborations, or other modifications
44
- represent, as a whole, an original work of authorship. For the purposes
45
- of this License, Derivative Works shall not include works that remain
46
- separable from, or merely link (or bind by name) to the interfaces of,
47
- the Work and Derivative Works thereof.
48
-
49
- "Contribution" shall mean any work of authorship, including
50
- the original version of the Work and any modifications or additions
51
- to that Work or Derivative Works thereof, that is intentionally
52
- submitted to Licensor for inclusion in the Work by the copyright owner
53
- or by an individual or Legal Entity authorized to submit on behalf of
54
- the copyright owner. For the purposes of this definition, "submitted"
55
- means any form of electronic, verbal, or written communication sent
56
- to the Licensor or its representatives, including but not limited to
57
- communication on electronic mailing lists, source code control systems,
58
- and issue tracking systems that are managed by, or on behalf of, the
59
- Licensor for the purpose of discussing and improving the Work, but
60
- excluding communication that is conspicuously marked or otherwise
61
- designated in writing by the copyright owner as "Not a Contribution."
62
-
63
- "Contributor" shall mean Licensor and any individual or Legal Entity
64
- on behalf of whom a Contribution has been received by Licensor and
65
- subsequently incorporated within the Work.
66
-
67
- 2. Grant of Copyright License. Subject to the terms and conditions of
68
- this License, each Contributor hereby grants to You a perpetual,
69
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
- copyright license to reproduce, prepare Derivative Works of,
71
- publicly display, publicly perform, sublicense, and distribute the
72
- Work and such Derivative Works in Source or Object form.
73
-
74
- 3. Grant of Patent License. Subject to the terms and conditions of
75
- this License, each Contributor hereby grants to You a perpetual,
76
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
- (except as stated in this section) patent license to make, have made,
78
- use, offer to sell, sell, import, and otherwise transfer the Work,
79
- where such license applies only to those patent claims licensable
80
- by such Contributor that are necessarily infringed by their
81
- Contribution(s) alone or by combination of their Contribution(s)
82
- with the Work to which such Contribution(s) was submitted. If You
83
- institute patent litigation against any entity (including a
84
- cross-claim or counterclaim in a lawsuit) alleging that the Work
85
- or a Contribution incorporated within the Work constitutes direct
86
- or contributory patent infringement, then any patent licenses
87
- granted to You under this License for that Work shall terminate
88
- as of the date such litigation is filed.
89
-
90
- 4. Redistribution. You may reproduce and distribute copies of the
91
- Work or Derivative Works thereof in any medium, with or without
92
- modifications, and in Source or Object form, provided that You
93
- meet the following conditions:
94
-
95
- (a) You must give any other recipients of the Work or
96
- Derivative Works a copy of this License; and
97
-
98
- (b) You must cause any modified files to carry prominent notices
99
- stating that You changed the files; and
100
-
101
- (c) You must retain, in the Source form of any Derivative Works
102
- that You distribute, all copyright, patent, trademark, and
103
- attribution notices from the Source form of the Work,
104
- excluding those notices that do not pertain to any part of
105
- the Derivative Works; and
106
-
107
- (d) If the Work includes a "NOTICE" text file as part of its
108
- distribution, then any Derivative Works that You distribute must
109
- include a readable copy of the attribution notices contained
110
- within such NOTICE file, excluding those notices that do not
111
- pertain to any part of the Derivative Works, in at least one
112
- of the following places: within a NOTICE text file distributed
113
- as part of the Derivative Works; within the Source form or
114
- documentation, if provided along with the Derivative Works; or,
115
- within a display generated by the Derivative Works, if and
116
- wherever such third-party notices normally appear. The contents
117
- of the NOTICE file are for informational purposes only and
118
- do not modify the License. You may add Your own attribution
119
- notices within Derivative Works that You distribute, alongside
120
- or as an addendum to the NOTICE text from the Work, provided
121
- that such additional attribution notices cannot be construed
122
- as modifying the License.
123
-
124
- You may add Your own copyright statement to Your modifications and
125
- may provide additional or different license terms and conditions
126
- for use, reproduction, or distribution of Your modifications, or
127
- for any such Derivative Works as a whole, provided Your use,
128
- reproduction, and distribution of the Work otherwise complies with
129
- the conditions stated in this License.
130
-
131
- 5. Submission of Contributions. Unless You explicitly state otherwise,
132
- any Contribution intentionally submitted for inclusion in the Work
133
- by You to the Licensor shall be under the terms and conditions of
134
- this License, without any additional terms or conditions.
135
- Notwithstanding the above, nothing herein shall supersede or modify
136
- the terms of any separate license agreement you may have executed
137
- with Licensor regarding such Contributions.
138
-
139
- 6. Trademarks. This License does not grant permission to use the trade
140
- names, trademarks, service marks, or product names of the Licensor,
141
- except as required for reasonable and customary use in describing the
142
- origin of the Work and reproducing the content of the NOTICE file.
143
-
144
- 7. Disclaimer of Warranty. Unless required by applicable law or
145
- agreed to in writing, Licensor provides the Work (and each
146
- Contributor provides its Contributions) on an "AS IS" BASIS,
147
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
- implied, including, without limitation, any warranties or conditions
149
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
- PARTICULAR PURPOSE. You are solely responsible for determining the
151
- appropriateness of using or redistributing the Work and assume any
152
- risks associated with Your exercise of permissions under this License.
153
-
154
- 8. Limitation of Liability. In no event and under no legal theory,
155
- whether in tort (including negligence), contract, or otherwise,
156
- unless required by applicable law (such as deliberate and grossly
157
- negligent acts) or agreed to in writing, shall any Contributor be
158
- liable to You for damages, including any direct, indirect, special,
159
- incidental, or consequential damages of any character arising as a
160
- result of this License or out of the use or inability to use the
161
- Work (including but not limited to damages for loss of goodwill,
162
- work stoppage, computer failure or malfunction, or any and all
163
- other commercial damages or losses), even if such Contributor
164
- has been advised of the possibility of such damages.
165
-
166
- 9. Accepting Warranty or Additional Liability. While redistributing
167
- the Work or Derivative Works thereof, You may choose to offer,
168
- and charge a fee for, acceptance of support, warranty, indemnity,
169
- or other liability obligations and/or rights consistent with this
170
- License. However, in accepting such obligations, You may act only
171
- on Your own behalf and on Your sole responsibility, not on behalf
172
- of any other Contributor, and only if You agree to indemnify,
173
- defend, and hold each Contributor harmless for any liability
174
- incurred by, or claims asserted against, such Contributor by reason
175
- of your accepting any such warranty or additional liability.
176
-
177
- END OF TERMS AND CONDITIONS
@@ -1,42 +0,0 @@
1
- ---
2
- name: frontend-design
3
- description: Create distinctive, production-grade frontend interfaces with high design quality. Use this skill when the user asks to build web components, pages, artifacts, posters, or applications (examples include websites, landing pages, dashboards, React components, HTML/CSS layouts, or when styling/beautifying any web UI). Generates creative, polished code and UI design that avoids generic AI aesthetics.
4
- license: Complete terms in LICENSE.txt
5
- ---
6
-
7
- This skill guides creation of distinctive, production-grade frontend interfaces that avoid generic "AI slop" aesthetics. Implement real working code with exceptional attention to aesthetic details and creative choices.
8
-
9
- The user provides frontend requirements: a component, page, application, or interface to build. They may include context about the purpose, audience, or technical constraints.
10
-
11
- ## Design Thinking
12
-
13
- Before coding, understand the context and commit to a BOLD aesthetic direction:
14
- - **Purpose**: What problem does this interface solve? Who uses it?
15
- - **Tone**: Pick an extreme: brutally minimal, maximalist chaos, retro-futuristic, organic/natural, luxury/refined, playful/toy-like, editorial/magazine, brutalist/raw, art deco/geometric, soft/pastel, industrial/utilitarian, etc. There are so many flavors to choose from. Use these for inspiration but design one that is true to the aesthetic direction.
16
- - **Constraints**: Technical requirements (framework, performance, accessibility).
17
- - **Differentiation**: What makes this UNFORGETTABLE? What's the one thing someone will remember?
18
-
19
- **CRITICAL**: Choose a clear conceptual direction and execute it with precision. Bold maximalism and refined minimalism both work - the key is intentionality, not intensity.
20
-
21
- Then implement working code (HTML/CSS/JS, React, Vue, etc.) that is:
22
- - Production-grade and functional
23
- - Visually striking and memorable
24
- - Cohesive with a clear aesthetic point-of-view
25
- - Meticulously refined in every detail
26
-
27
- ## Frontend Aesthetics Guidelines
28
-
29
- Focus on:
30
- - **Typography**: Choose fonts that are beautiful, unique, and interesting. Avoid generic fonts like Arial and Inter; opt instead for distinctive choices that elevate the frontend's aesthetics; unexpected, characterful font choices. Pair a distinctive display font with a refined body font.
31
- - **Color & Theme**: Commit to a cohesive aesthetic. Use CSS variables for consistency. Dominant colors with sharp accents outperform timid, evenly-distributed palettes.
32
- - **Motion**: Use animations for effects and micro-interactions. Prioritize CSS-only solutions for HTML. Use Motion library for React when available. Focus on high-impact moments: one well-orchestrated page load with staggered reveals (animation-delay) creates more delight than scattered micro-interactions. Use scroll-triggering and hover states that surprise.
33
- - **Spatial Composition**: Unexpected layouts. Asymmetry. Overlap. Diagonal flow. Grid-breaking elements. Generous negative space OR controlled density.
34
- - **Backgrounds & Visual Details**: Create atmosphere and depth rather than defaulting to solid colors. Add contextual effects and textures that match the overall aesthetic. Apply creative forms like gradient meshes, noise textures, geometric patterns, layered transparencies, dramatic shadows, decorative borders, custom cursors, and grain overlays.
35
-
36
- NEVER use generic AI-generated aesthetics like overused font families (Inter, Roboto, Arial, system fonts), cliched color schemes (particularly purple gradients on white backgrounds), predictable layouts and component patterns, and cookie-cutter design that lacks context-specific character.
37
-
38
- Interpret creatively and make unexpected choices that feel genuinely designed for the context. No design should be the same. Vary between light and dark themes, different fonts, different aesthetics. NEVER converge on common choices (Space Grotesk, for example) across generations.
39
-
40
- **IMPORTANT**: Match implementation complexity to the aesthetic vision. Maximalist designs need elaborate code with extensive animations and effects. Minimalist or refined designs need restraint, precision, and careful attention to spacing, typography, and subtle details. Elegance comes from executing the vision well.
41
-
42
- Remember: Claude is capable of extraordinary creative work. Don't hold back, show what can truly be created when thinking outside the box and committing fully to a distinctive vision.
@@ -1,46 +0,0 @@
1
- ---
2
- name: 'code-review'
3
- description: 'Perform a standardized code review on the current changes. Use this when needing to evaluate how well the code matches our architecture docs, code quality, and so on.'
4
- allowed-tools:
5
- - execute/runInTerminal
6
- - edit/editFiles
7
- - edit/createFile
8
- - atlassian-rovo/*
9
- ---
10
-
11
- # Brain Studio — Code Review
12
-
13
- ## Setup
14
-
15
- 1. Use #tool:execute/runInTerminal to run `git diff origin/main...HEAD`. If that yields nothing, fall back to `git diff HEAD`. Use this output as the set of changes under review.
16
- 2. Use #tool:execute/runInTerminal to run `git branch --show-current` and extract the Jira ticket key from the branch name (e.g. `BS-1056` from `BS-1056-my-feature`). If a ticket key is found, use the Atlassian Rovo MCP to fetch the issue and use its description and acceptance criteria to evaluate whether the code fulfils the ticket's intent.
17
- 3. Inspect the diff to understand what types of changes are involved.
18
- 4. Apply the **Doc Routing Table** in `.github/copilot-instructions.md` — use the change types you identified to determine which architecture docs to load. Use those docs as your source of truth throughout the review.
19
- 5. If the codebase contradicts the docs, the **docs represent the target state** — flag the discrepancy rather than normalising the legacy pattern.
20
-
21
- ---
22
-
23
- ## Review
24
-
25
- Evaluate the changes across these areas. Let the loaded architecture docs govern the specific standards — do not invent rules not found there.
26
-
27
- 1. **Code Quality** — single responsibility principle, clarity, naming, redundancy, complexity, consistency with documented patterns
28
- 2. **Regressions** — silent breakage, unexpected behaviour changes, altered logic outside of the stated scope of the ticket, downstream impact
29
- 3. **Security** — input validation, sensitive data handling, auth correctness
30
- 4. **Performance** — inefficient or unnecessarily expensive code, unnecessary re-renders, missing cleanups, over-importing
31
- 5. **Error handling** — async error paths covered, error messaging in place, graceful degradation, no swallowed errors
32
- 6. **Accessibility** — semantic HTML, ARIA attributes, keyboard navigation, focus management
33
- 7. **Testing** — coverage of new logic, edge cases, error paths; flag superfluous tests
34
- 8. **Documentation** — non-obvious logic commented; JSDoc updated where needed, architecture docs updated if the change introduces a new pattern or deviates from existing ones
35
-
36
- ---
37
-
38
- ## Output Format
39
-
40
- - **Inline comments** for specific lines or blocks.
41
- - **Top-level observations** for broad themes or praise.
42
- - Prioritise by severity: 🔴 blocking / 🟡 important / 🔵 minor.
43
- - Do **not** include your reasoning steps or to-do list.
44
- - Close with a witty quatrain summarising the PR. 🎭
45
-
46
- Save the review to `docs/code-reviews/<branch-name>-code-review.md` (use the full branch name from Setup step 2). Confirm the file has been written.
@@ -1,102 +0,0 @@
1
- # rzlv-flow: Atlassian Intelligence Skills
2
-
3
- A toolset of modular, composable skills for Jira and Confluence developer workflows. Covers daily triage, ticket focus, wrap/sync, sprint status, context loading, and more — all without requiring the full BMAD Method or the rzlv-flow monolith.
4
-
5
- Each skill is standalone and can be installed individually or as a complete suite.
6
-
7
- ## Quick Start
8
-
9
- ```bash
10
- # 1. Install all skills + resources
11
- npx @groupby/ai-dev install toolset rzlv-flow
12
-
13
- # 2. Configure Atlassian MCP (see docs/mcp-setup.md)
14
- # Add atlassian-rovo config to .vscode/mcp.json
15
-
16
- # 3. Use — ask your AI assistant:
17
- # "Start my day" → daily triage
18
- # "Focus on PROJ-123" → ticket deep-dive
19
- # "Wrap up PROJ-123" → wrap & sync
20
- ```
21
-
22
- See [docs/getting-started.md](docs/getting-started.md) for a full walkthrough.
23
-
24
- ## Skills
25
-
26
- | Skill | Description | Status |
27
- |-------|-------------|--------|
28
- | `jira-daily-triage` | Start-of-day ticket triage with sprint detection | Complete |
29
- | `jira-ticket-focus` | Deep-load a ticket with full context | Complete |
30
- | `jira-wrap-sync` | Wrap up work, draft comment, multi-action sync | Complete |
31
- | `jira-ticket-trace` | Trace code back to Jira requirements | Complete |
32
- | `jira-comment` | Add a comment to a Jira ticket with FCMP safety | Complete |
33
- | `jira-status` | Change ticket status with transition validation | Complete |
34
- | `jira-sprint-status` | Sprint status report with completion metrics | Complete |
35
- | `jira-sync` | Force-sync local Jira context with remote state | Complete |
36
- | `atlassian-orchestrator` | Pull surrounding ticket context and create structures | Complete |
37
- | `context-analyst` | Transform meeting transcripts into structured docs | Complete |
38
- | `confluence-publish` | Publish local markdown to Confluence with Leaf Bundle mirrors | Complete |
39
- | `confluence-fetch` | Pull a Confluence page into a local markdown mirror | Complete |
40
-
41
- > **Note:** `confluence-publish` provides lightweight ad-hoc publishing to Confluence. For bulk structured sync of `_docs/` folders following epic hierarchy, use `atlassian-orchestrator` Mode 3 instead.
42
-
43
- ## Prerequisites
44
-
45
- ### Required: Atlassian MCP (`atlassian-rovo`)
46
-
47
- All Jira and Confluence skills require the Atlassian MCP server for API access to your Atlassian instance.
48
-
49
- ### Optional: GitHub MCP
50
-
51
- Only needed for PR creation features in `jira-wrap-sync`. Not required for any other skills.
52
-
53
- See [docs/mcp-setup.md](docs/mcp-setup.md) for detailed setup instructions.
54
-
55
- ## Installation
56
-
57
- ```bash
58
- npx @groupby/ai-dev install toolset rzlv-flow # All skills + resources
59
- npx @groupby/ai-dev install skill jira-daily-triage # Individual skill
60
- ```
61
-
62
- Common options:
63
-
64
- | Flag | Description |
65
- |------|-------------|
66
- | `--target <dir>` | Install into a specific directory (defaults to cwd) |
67
- | `--dry-run` | Preview what would be installed without writing files |
68
- | `--force` | Overwrite existing files without prompting |
69
- | `--skip-existing` | Skip files that already exist |
70
-
71
- You can also copy skills manually from this repository into `docs/ai/skills/` and resources into `docs/ai/resources/`.
72
-
73
- ## BMAD Compatibility
74
-
75
- These skills are compatible with BMAD's Jira file structure (`docs/jira/{instance}/{project}/...`) but do **not** require BMAD. They were originally developed as part of the BMAD "Atlassian Intelligence Suite" and have been extracted as standalone skills. If BMAD is installed in your project, these skills coexist without conflict.
76
-
77
- ## Shared Resources
78
-
79
- Skills reference shared resource files installed to `docs/ai/resources/` in your project:
80
-
81
- | Resource | Description |
82
- |----------|-------------|
83
- | `fcmp-protocol.md` | Fetch-Compare-Merge-Push sync pattern for safe Atlassian read/write |
84
- | `jira-file-structure.md` | Standard directory layout for local Jira mirrors |
85
- | `confluence-file-structure.md` | Leaf Bundle pattern for Confluence page mirrors |
86
- | `sync-state-format.md` | YAML frontmatter schema for ticket and page files |
87
- | `confluence-page-templates/` | Starter scaffolds for Confluence pages (initiative overview, strategic context, technical architecture, decisions) |
88
-
89
- ## MCP Setup Automation
90
-
91
- MCP server configuration is currently manual — see [docs/mcp-setup.md](docs/mcp-setup.md) for step-by-step instructions (~5 minutes). Automated MCP configuration via the CLI is a future enhancement.
92
-
93
- ## Documentation
94
-
95
- | Doc | Description |
96
- |-----|-------------|
97
- | [docs/getting-started.md](docs/getting-started.md) | Quick walkthrough: install → configure → use |
98
- | [docs/mcp-setup.md](docs/mcp-setup.md) | Atlassian and GitHub MCP server configuration |
99
-
100
- ## Contributing
101
-
102
- See the [architecture documentation](../../docs/architecture/README.md) for repo structure, skill authoring guides, and conventions.
@@ -1,126 +0,0 @@
1
- # MCP Server Setup Guide
2
-
3
- This guide covers configuring the MCP servers required by rzlv-flow skills.
4
-
5
- ---
6
-
7
- ## Atlassian MCP (`atlassian-rovo`) — Required
8
-
9
- All Jira and Confluence skills depend on the Atlassian MCP server for API access.
10
-
11
- ### VS Code Configuration
12
-
13
- Add the following to your `.vscode/mcp.json` (create the file if it doesn't exist):
14
-
15
- ```json
16
- {
17
- "servers": {
18
- "atlassian-rovo": {
19
- "command": "npx",
20
- "args": ["-y", "@anthropic/atlassian-rovo-mcp"],
21
- "env": {
22
- "ATLASSIAN_SITE": "your-company.atlassian.net",
23
- "ATLASSIAN_EMAIL": "you@company.com",
24
- "ATLASSIAN_API_TOKEN": "${input:atlassianApiToken}"
25
- }
26
- }
27
- },
28
- "inputs": [
29
- {
30
- "type": "promptString",
31
- "id": "atlassianApiToken",
32
- "description": "Atlassian API Token",
33
- "password": true
34
- }
35
- ]
36
- }
37
- ```
38
-
39
- ### Generating an API Token
40
-
41
- 1. Go to [https://id.atlassian.com/manage-profile/security/api-tokens](https://id.atlassian.com/manage-profile/security/api-tokens)
42
- 2. Click **Create API token**
43
- 3. Give it a label (e.g. "VS Code MCP")
44
- 4. Copy the generated token — you won't see it again
45
-
46
- ### Verifying the Connection
47
-
48
- After configuring, ask the LLM to run a simple query:
49
-
50
- > "Search Jira for my open tickets using the Atlassian MCP"
51
-
52
- If the MCP server is configured correctly, it will call `mcp_atlassian-rovo_search` and return results. If you get an authentication error, double-check your site URL, email, and API token.
53
-
54
- ---
55
-
56
- ## GitHub MCP — Optional
57
-
58
- Only needed for PR creation features in the `jira-wrap-sync` skill. All other skills work without it.
59
-
60
- ### VS Code Configuration
61
-
62
- Add to your `.vscode/mcp.json`:
63
-
64
- ```json
65
- {
66
- "servers": {
67
- "github": {
68
- "command": "npx",
69
- "args": ["-y", "@modelcontextprotocol/server-github"],
70
- "env": {
71
- "GITHUB_PERSONAL_ACCESS_TOKEN": "${input:githubPat}"
72
- }
73
- }
74
- },
75
- "inputs": [
76
- {
77
- "type": "promptString",
78
- "id": "githubPat",
79
- "description": "GitHub Personal Access Token",
80
- "password": true
81
- }
82
- ]
83
- }
84
- ```
85
-
86
- ### PAT Token Requirements
87
-
88
- Create a fine-grained personal access token at [https://github.com/settings/tokens?type=beta](https://github.com/settings/tokens?type=beta) with the following scopes:
89
-
90
- - **Repository access:** Select the repos you work with
91
- - **Permissions:**
92
- - Contents: Read and write
93
- - Pull requests: Read and write
94
- - Metadata: Read-only
95
-
96
- ### When It's Needed
97
-
98
- Only `jira-wrap-sync` uses the GitHub MCP — specifically when creating a pull request as part of the wrap-up workflow. If you don't use that feature, you can skip this setup entirely.
99
-
100
- ---
101
-
102
- ## Troubleshooting
103
-
104
- ### MCP server not starting
105
-
106
- - Ensure `npx` is available in your PATH. Run `npx --version` in your terminal.
107
- - Check the VS Code Output panel (View → Output → select "MCP" from the dropdown) for error messages.
108
- - Try running the `npx` command manually in a terminal to see if it installs and starts correctly.
109
-
110
- ### Authentication failures (401)
111
-
112
- - **Atlassian:** Verify your site URL includes `.atlassian.net` (not the full `https://` URL). Confirm your email matches your Atlassian account. Regenerate the API token if needed.
113
- - **GitHub:** Confirm the PAT hasn't expired. Check that it has the required scopes.
114
-
115
- ### Wrong Atlassian instance
116
-
117
- - `ATLASSIAN_SITE` should be just the domain, e.g. `your-company.atlassian.net` — not a full URL like `https://your-company.atlassian.net/jira`.
118
-
119
- ### Rate limiting
120
-
121
- - Atlassian APIs have rate limits. If you see 429 errors, the skills will back off automatically per the FCMP protocol. Avoid running multiple sync operations in rapid succession.
122
-
123
- ### MCP calls return empty results
124
-
125
- - Confirm you have permission to access the Jira project or Confluence space you're querying.
126
- - Check that the project key or space key is correct.
@@ -1,16 +0,0 @@
1
- # rzlv-flow Shared Resources
2
-
3
- Resources are shared reference material installed alongside skills. They contain protocol definitions, file structure conventions, and schema specifications that multiple skills depend on.
4
-
5
- ## Installation
6
-
7
- When installed via the CLI, resources are placed in `docs/ai/resources/` in the target project. Skills reference them via relative paths and may ask the LLM to load them at the start of a workflow.
8
-
9
- ## Resource Files
10
-
11
- | File | Description |
12
- |------|-------------|
13
- | `fcmp-protocol.md` | Fetch-Compare-Merge-Push sync pattern — the core protocol for safe Atlassian read/write operations |
14
- | `jira-file-structure.md` | Standard directory layout for local Jira mirrors (`docs/jira/{instance}/{project}/...`) |
15
- | `confluence-file-structure.md` | Directory layout for local Confluence page mirrors with structured and flexible modes |
16
- | `sync-state-format.md` | YAML frontmatter schema for Jira ticket and Confluence page files |