@mohammadhprp/system-prompt 0.12.0 → 0.12.2
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.
- package/framework/agents/README.md +0 -1
- package/framework/commands/mr.md +8 -9
- package/framework/mcps/README.md +0 -3
- package/framework/skills/README.md +5 -4
- package/framework/skills/effective-html/SKILL.md +63 -0
- package/framework/skills/effective-html/examples.md +19 -0
- package/framework/skills/effective-html/references/charts-and-data.md +32 -0
- package/framework/skills/effective-html/references/creative-direction.md +48 -0
- package/framework/skills/effective-html/references/design-artifact.md +78 -0
- package/framework/skills/effective-html/references/diagrams.md +68 -0
- package/framework/skills/effective-html/references/documents-and-presentations.md +28 -0
- package/framework/skills/effective-html/references/html-diagram.md +43 -0
- package/framework/skills/effective-html/references/html-plan.md +40 -0
- package/framework/skills/effective-html/references/html-prototype.md +97 -0
- package/framework/skills/effective-html/references/html-wireframe.md +81 -0
- package/framework/skills/effective-html/references/html.md +72 -0
- package/framework/skills/effective-html/references/interfaces.md +17 -0
- package/framework/skills/glab/SKILL.md +222 -0
- package/framework/skills/glab/references/commands-detailed.md +616 -0
- package/framework/skills/glab/references/quick-reference.md +145 -0
- package/framework/skills/glab/references/troubleshooting.md +669 -0
- package/framework/skills/great-interface/SKILL.md +43 -0
- package/framework/skills/great-interface/references/animations.md +205 -0
- package/framework/skills/great-interface/references/better-accessibility.md +106 -0
- package/framework/skills/great-interface/references/better-colors.md +100 -0
- package/framework/skills/great-interface/references/better-interface.md +132 -0
- package/framework/skills/great-interface/references/better-layout.md +76 -0
- package/framework/skills/great-interface/references/better-typography.md +157 -0
- package/framework/skills/great-interface/references/better-ui.md +107 -0
- package/framework/skills/great-interface/references/better-writing.md +109 -0
- package/framework/skills/great-interface/references/choosing-fonts.md +64 -0
- package/framework/skills/great-interface/references/color-formats.md +90 -0
- package/framework/skills/great-interface/references/color-usage.md +118 -0
- package/framework/skills/great-interface/references/contrast.md +79 -0
- package/framework/skills/great-interface/references/css-cheat-sheet.md +65 -0
- package/framework/skills/great-interface/references/details-and-accessibility.md +119 -0
- package/framework/skills/great-interface/references/enter-exit.md +147 -0
- package/framework/skills/great-interface/references/explain-interface.md +126 -0
- package/framework/skills/great-interface/references/find-the-effect.md +94 -0
- package/framework/skills/great-interface/references/focus-and-keyboard.md +131 -0
- package/framework/skills/great-interface/references/forms.md +84 -0
- package/framework/skills/great-interface/references/from-an-image.md +55 -0
- package/framework/skills/great-interface/references/grouping-and-alignment.md +123 -0
- package/framework/skills/great-interface/references/hit-areas.md +94 -0
- package/framework/skills/great-interface/references/icon-transitions.md +102 -0
- package/framework/skills/great-interface/references/icons.md +110 -0
- package/framework/skills/great-interface/references/interface-review.md +148 -0
- package/framework/skills/great-interface/references/motion-and-zoom.md +79 -0
- package/framework/skills/great-interface/references/no-browser.md +73 -0
- package/framework/skills/great-interface/references/palette-generation.md +104 -0
- package/framework/skills/great-interface/references/palette-structure.md +76 -0
- package/framework/skills/great-interface/references/performance.md +88 -0
- package/framework/skills/great-interface/references/picker.md +76 -0
- package/framework/skills/great-interface/references/read-the-system.md +178 -0
- package/framework/skills/great-interface/references/removed-signals.md +38 -0
- package/framework/skills/great-interface/references/review-format.md +46 -0
- package/framework/skills/great-interface/references/scope-resolution.md +88 -0
- package/framework/skills/great-interface/references/screen-readers.md +101 -0
- package/framework/skills/great-interface/references/semantics-and-aria.md +84 -0
- package/framework/skills/great-interface/references/spacing-and-adaptivity.md +159 -0
- package/framework/skills/great-interface/references/spacing-and-sizing.md +121 -0
- package/framework/skills/great-interface/references/surfaces.md +219 -0
- package/framework/skills/great-interface/references/token-naming.md +97 -0
- package/framework/skills/great-interface/references/variable-fonts-and-opentype.md +105 -0
- package/framework/skills/great-interface/references/variant.md +104 -0
- package/framework/skills/great-interface/references/wrapping-and-punctuation.md +55 -0
- package/framework/skills/improve/SKILL.md +137 -0
- package/framework/skills/improve/examples.md +19 -0
- package/framework/skills/improve/references/audit-playbook.md +130 -0
- package/framework/skills/improve/references/closing-the-loop.md +96 -0
- package/framework/skills/improve/references/plan-template.md +197 -0
- package/framework/skills/jira-cli/SKILL.md +260 -0
- package/framework/skills/jira-cli/references/commands-detailed.md +268 -0
- package/framework/skills/jira-cli/references/quick-reference.md +111 -0
- package/framework/skills/jira-cli/references/troubleshooting.md +114 -0
- package/framework/styles/README.md +9 -4
- package/framework/styles/factory/DESIGN.md +360 -0
- package/framework/styles/factory/README.md +32 -0
- package/framework/styles/factory/assets/preview.jpg +0 -0
- package/framework/styles/huly/DESIGN.md +449 -0
- package/framework/styles/huly/README.md +32 -0
- package/framework/styles/huly/assets/preview.jpg +0 -0
- package/framework/styles/notion/DESIGN.md +423 -0
- package/framework/styles/notion/README.md +32 -0
- package/framework/styles/notion/assets/preview.jpg +0 -0
- package/package.json +1 -1
- package/src/catalog.js +8 -8
- package/framework/agents/backend-architect.md +0 -146
- package/framework/mcps/github-mcp/README.md +0 -51
- package/framework/mcps/github-mcp/capabilities.md +0 -83
- package/framework/mcps/github-mcp/configs/.env.example +0 -1
- package/framework/mcps/github-mcp/configs/opencode.json +0 -13
- package/framework/mcps/github-mcp/install.md +0 -60
- package/framework/mcps/github-mcp/troubleshooting.md +0 -79
- package/framework/mcps/gitlab-mcp/README.md +0 -53
- package/framework/mcps/gitlab-mcp/capabilities.md +0 -216
- package/framework/mcps/gitlab-mcp/configs/.env.example +0 -2
- package/framework/mcps/gitlab-mcp/configs/opencode.json +0 -13
- package/framework/mcps/gitlab-mcp/install.md +0 -99
- package/framework/mcps/gitlab-mcp/troubleshooting.md +0 -116
- package/framework/mcps/jira-mcp/README.md +0 -52
- package/framework/mcps/jira-mcp/capabilities.md +0 -79
- package/framework/mcps/jira-mcp/configs/.env.example +0 -2
- package/framework/mcps/jira-mcp/configs/opencode.json +0 -13
- package/framework/mcps/jira-mcp/install.md +0 -94
- package/framework/mcps/jira-mcp/troubleshooting.md +0 -113
- package/framework/skills/brand-guidelines/LICENSE.txt +0 -202
- package/framework/skills/brand-guidelines/SKILL.md +0 -73
- package/framework/skills/gitlab-mcp/SKILL.md +0 -83
- package/framework/skills/gitlab-mcp/examples.md +0 -31
- package/framework/skills/gitlab-mcp/references/code-review.md +0 -110
- package/framework/skills/gitlab-mcp/references/issues.md +0 -141
- package/framework/skills/gitlab-mcp/references/merge-requests.md +0 -120
- package/framework/skills/gitlab-mcp/references/pipelines.md +0 -67
- package/framework/skills/gitlab-mcp/references/search.md +0 -17
- package/framework/skills/gitlab-mcp/references/webhooks.md +0 -32
- package/framework/skills/gitlab-mcp/references/work-items.md +0 -50
- package/framework/skills/jira-mcp/SKILL.md +0 -57
- package/framework/skills/jira-mcp/examples.md +0 -31
- package/framework/skills/jira-mcp/references/comments.md +0 -27
- package/framework/skills/jira-mcp/references/issues.md +0 -97
- package/framework/skills/jira-mcp/references/projects.md +0 -39
- package/framework/skills/lavish/SKILL.md +0 -67
- package/framework/skills/lavish/examples.md +0 -31
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
# Work Item Operations
|
|
2
|
-
|
|
3
|
-
> **Opt-in toolset**: Enable with `GITLAB_TOOLSETS=workitems`
|
|
4
|
-
|
|
5
|
-
Work items are GraphQL-based and cover issues, tasks, incidents, epics, objectives, requirements, tickets, and related hierarchy/status fields. Some status and custom field features require GitLab Premium/Ultimate.
|
|
6
|
-
|
|
7
|
-
## Read
|
|
8
|
-
|
|
9
|
-
```
|
|
10
|
-
list_work_items -> list work items with filters
|
|
11
|
-
get_work_item -> full details with status, hierarchy, type, labels, assignees, widgets
|
|
12
|
-
list_work_item_notes -> notes and discussions on a work item
|
|
13
|
-
list_work_item_statuses -> available statuses for a work item type
|
|
14
|
-
list_custom_field_definitions -> custom field definitions for a work item type
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
## Create & Update
|
|
18
|
-
|
|
19
|
-
```
|
|
20
|
-
create_work_item
|
|
21
|
-
project_id: "my-group/my-project"
|
|
22
|
-
title: "Investigate checkout failure"
|
|
23
|
-
work_item_type: "issue"
|
|
24
|
-
description: "Steps to reproduce..."
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
```
|
|
28
|
-
update_work_item -> title, description, labels, assignees, state, parent, children, health, dates, custom fields
|
|
29
|
-
convert_work_item_type -> convert issue/task/incident/etc.
|
|
30
|
-
move_work_item -> move a work item to another project
|
|
31
|
-
create_work_item_note -> add a note, threaded reply, or internal note
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
## Emoji Reactions
|
|
35
|
-
|
|
36
|
-
```
|
|
37
|
-
list_work_item_emoji_reactions -> list reactions on a work item
|
|
38
|
-
create_work_item_emoji_reaction -> add reaction to a work item
|
|
39
|
-
delete_work_item_emoji_reaction -> remove reaction from a work item
|
|
40
|
-
list_work_item_note_emoji_reactions -> list reactions on a work item note or thread reply
|
|
41
|
-
create_work_item_note_emoji_reaction -> add reaction to a work item note or thread reply
|
|
42
|
-
delete_work_item_note_emoji_reaction -> remove reaction from a work item note or thread reply
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
## Incident Timeline
|
|
46
|
-
|
|
47
|
-
```
|
|
48
|
-
get_timeline_events -> list timeline events for an incident
|
|
49
|
-
create_timeline_event -> create an incident timeline event
|
|
50
|
-
```
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: jira-mcp
|
|
3
|
-
description: Use this skill when working with the Jira MCP server tools for issue management, project management, comments, search, and related Jira workflows.
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# jira-mcp
|
|
7
|
-
|
|
8
|
-
Jira MCP server providing 12 tools for interacting with your self-hosted Jira instance via the REST API v2.
|
|
9
|
-
|
|
10
|
-
## Tools
|
|
11
|
-
|
|
12
|
-
| Category | Tools | Default |
|
|
13
|
-
|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------|---------|
|
|
14
|
-
| Issues (9 tools) | `create_issue`, `get_issue`, `update_issue`, `delete_issue`, `search_issues`, `assign_issue`, `get_issue_types`, `add_comment`, `get_comments` | yes |
|
|
15
|
-
| Projects (2 tools) | `get_projects`, `get_project` | yes |
|
|
16
|
-
| Users (1 tool) | `get_current_user` | yes |
|
|
17
|
-
|
|
18
|
-
All tools are available by default — there are no opt-in toolsets for this server.
|
|
19
|
-
|
|
20
|
-
## Key Workflows
|
|
21
|
-
|
|
22
|
-
### Issue Lifecycle
|
|
23
|
-
|
|
24
|
-
`search_issues` → `get_issue` → `update_issue` / `assign_issue`
|
|
25
|
-
|
|
26
|
-
### Create Issue (see references/issues.md)
|
|
27
|
-
|
|
28
|
-
`get_project` → `get_issue_types` → `create_issue`
|
|
29
|
-
|
|
30
|
-
### Comment Thread (see references/comments.md)
|
|
31
|
-
|
|
32
|
-
`add_comment` → `get_comments`
|
|
33
|
-
|
|
34
|
-
### Project Discovery (see references/projects.md)
|
|
35
|
-
|
|
36
|
-
`get_projects` → `get_project` → `get_issue_types`
|
|
37
|
-
|
|
38
|
-
## Parameter Hints
|
|
39
|
-
|
|
40
|
-
- **projectKey**: uppercase project key (e.g., `PROJ`, `SCRUM`, `SUP`). Use `get_projects` to discover available keys.
|
|
41
|
-
- **issueKey**: format `PROJECT-123` (e.g., `CHI-42`, `DEV-1337`)
|
|
42
|
-
- **issueType**: varies by project — use `get_issue_types` to list valid types before creating. Common types: `Bug`, `Task`, `Story`, `Epic`, `Sub-task`
|
|
43
|
-
- **search_issues**: uses JQL (Jira Query Language). Complex values (spaces, special chars) must be quoted: `status = "In Progress"`, `project = PROJ`
|
|
44
|
-
- **Jql**: provide a raw JQL query string (not single-quoted — use double quotes inside for string values)
|
|
45
|
-
- **maxResults**: `search_issues` defaults to 50. Increase for larger result sets.
|
|
46
|
-
- **assignee**: Jira username (not display name or email). Use `get_current_user` to find your own username.
|
|
47
|
-
- **Custom fields**: Pass custom field values directly as parameters (e.g., `customfield_10211: "Sprint 1"`). Discover field IDs via Jira REST API.
|
|
48
|
-
|
|
49
|
-
## Destructive Tools
|
|
50
|
-
|
|
51
|
-
`delete_issue` — permanently deletes an issue. Cannot be undone.
|
|
52
|
-
|
|
53
|
-
## Advanced
|
|
54
|
-
|
|
55
|
-
- **JQL Search**: full Jira Query Language support — combine operators (`AND`, `OR`, `NOT`), functions (`currentUser()`, `now()`, `startOfDay()`), and ordering (`ORDER BY created DESC`)
|
|
56
|
-
- **Status transitions**: use `update_issue` with `status` to transition issues (e.g., `"In Progress"`, `"Done"`, `"Closed"`). Valid statuses depend on the project's workflow configuration.
|
|
57
|
-
- **Custom fields**: map Jira custom field IDs to values via the `customFields` object or direct parameter names
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
# Jira MCP Examples
|
|
2
|
-
|
|
3
|
-
## Example 1: Create and Assign a Bug
|
|
4
|
-
|
|
5
|
-
A production bug is discovered and needs to be tracked. Good agent behavior:
|
|
6
|
-
|
|
7
|
-
- Use `jira_get_projects` to find the correct project key.
|
|
8
|
-
- Use `jira_get_issue_types` to confirm valid types for the project.
|
|
9
|
-
- Use `jira_create_issue` with project key, summary, description, priority, and labels.
|
|
10
|
-
- Use `jira_assign_issue` to assign the bug to the responsible developer.
|
|
11
|
-
- Use `jira_add_comment` to include reproduction steps and environment details.
|
|
12
|
-
|
|
13
|
-
## Example 2: Find and Update Issues
|
|
14
|
-
|
|
15
|
-
Search for all high-priority unresolved issues assigned to the user. Good agent behavior:
|
|
16
|
-
|
|
17
|
-
- Use `jira_search_issues` with a JQL query like `assignee = currentUser() AND priority = High AND status != Done`.
|
|
18
|
-
- Use `jira_get_issue` on each result to review full details.
|
|
19
|
-
- Use `jira_update_issue` to transition the status to "In Progress".
|
|
20
|
-
- Use `jira_add_comment` to log what work is being started.
|
|
21
|
-
- Summarize the findings in a structured report grouped by status.
|
|
22
|
-
|
|
23
|
-
## Example 3: Close a Sprint Task
|
|
24
|
-
|
|
25
|
-
A task is complete and ready to close. Good agent behavior:
|
|
26
|
-
|
|
27
|
-
- Use `jira_get_current_user` to verify authentication is working.
|
|
28
|
-
- Use `jira_search_issues` to find the task by key or summary.
|
|
29
|
-
- Use `jira_get_issue` to review current status, assignee, and description.
|
|
30
|
-
- Use `jira_update_issue` to set status to "Done" and add a resolution note.
|
|
31
|
-
- Use `jira_add_comment` to document what was completed and any follow-ups.
|
|
@@ -1,27 +0,0 @@
|
|
|
1
|
-
# Comments
|
|
2
|
-
|
|
3
|
-
## Add Comment
|
|
4
|
-
|
|
5
|
-
```
|
|
6
|
-
add_comment
|
|
7
|
-
issueKey: "PROJ-123"
|
|
8
|
-
comment: "Fixed in latest deployment (v2.4.1)"
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
Adds a text comment to a Jira issue. No support for rich text or attachments via this server.
|
|
12
|
-
|
|
13
|
-
## Read Comments
|
|
14
|
-
|
|
15
|
-
```
|
|
16
|
-
get_comments
|
|
17
|
-
issueKey: "PROJ-123"
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Returns all comments on an issue, ordered by creation date (ascending). Each comment includes `body`, `author`, `created`, and `updated` timestamps.
|
|
21
|
-
|
|
22
|
-
## Limitations
|
|
23
|
-
|
|
24
|
-
- **No edit/update** — the current Jira MCP server does not provide an edit-comment tool
|
|
25
|
-
- **No delete** — comments cannot be removed via this server
|
|
26
|
-
- **No threading/replies** — comments are flat (Jira Cloud's threading is not exposed via this API)
|
|
27
|
-
- **No rich text** — plain text only; HTML/markdown in bodies may be rendered by Jira's API
|
|
@@ -1,97 +0,0 @@
|
|
|
1
|
-
# Issue Management
|
|
2
|
-
|
|
3
|
-
## Create
|
|
4
|
-
|
|
5
|
-
```
|
|
6
|
-
create_issue
|
|
7
|
-
projectKey: "PROJ"
|
|
8
|
-
summary: "Login page returns 500"
|
|
9
|
-
issueType: "Bug"
|
|
10
|
-
description: "Steps to reproduce..."
|
|
11
|
-
priority: "High"
|
|
12
|
-
labels: ["bug", "critical"]
|
|
13
|
-
assignee: "john.doe"
|
|
14
|
-
components: ["frontend"]
|
|
15
|
-
customfield_10211: "Sprint 1" # optional custom fields
|
|
16
|
-
```
|
|
17
|
-
|
|
18
|
-
Always verify project and issue types first:
|
|
19
|
-
|
|
20
|
-
1. `get_projects` → find project key
|
|
21
|
-
2. `get_issue_types` with `projectKey: "PROJ"` → find valid types
|
|
22
|
-
3. `create_issue` with valid `projectKey` and `issueType`
|
|
23
|
-
|
|
24
|
-
## Read
|
|
25
|
-
|
|
26
|
-
```
|
|
27
|
-
get_issue
|
|
28
|
-
issueKey: "PROJ-123"
|
|
29
|
-
```
|
|
30
|
-
|
|
31
|
-
Returns full issue details: summary, description, status, priority, assignee, reporter, labels, components, custom fields, timestamps.
|
|
32
|
-
|
|
33
|
-
## Search (JQL)
|
|
34
|
-
|
|
35
|
-
```
|
|
36
|
-
search_issues
|
|
37
|
-
jql: "project = PROJ AND status = Open"
|
|
38
|
-
maxResults: 50
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
### Common JQL Patterns
|
|
42
|
-
|
|
43
|
-
| Purpose | JQL |
|
|
44
|
-
| ------- | --- |
|
|
45
|
-
| My open issues | `assignee = currentUser() AND status != Done` |
|
|
46
|
-
| High priority recent | `priority = High AND created >= -7d` |
|
|
47
|
-
| By status | `status IN (Open, "In Progress", "Reopened")` |
|
|
48
|
-
| By label | `labels = "bug" OR labels = "critical"` |
|
|
49
|
-
| By reporter | `reporter = john.doe AND status NOT IN (Closed, Done)` |
|
|
50
|
-
| Unassigned | `assignee IS NULL AND status NOT IN (Closed, Done, Resolved)` |
|
|
51
|
-
| Sprints (custom field) | `cf[10211] = "Sprint 1"` |
|
|
52
|
-
| Date range | `created >= "2025-01-01" AND created <= "2025-06-01"` |
|
|
53
|
-
| Order by | `project = PROJ ORDER BY priority DESC, created ASC` |
|
|
54
|
-
| Text search | `text ~ "error message"` |
|
|
55
|
-
| Across all projects | `status = Open AND assignee = currentUser()` |
|
|
56
|
-
|
|
57
|
-
`search_issues` defaults to showing issues across **all projects** the user has access to. Scope to a specific project with `project = KEY`.
|
|
58
|
-
|
|
59
|
-
## Update
|
|
60
|
-
|
|
61
|
-
```
|
|
62
|
-
update_issue
|
|
63
|
-
issueKey: "PROJ-123"
|
|
64
|
-
summary: "Updated title"
|
|
65
|
-
description: "New description"
|
|
66
|
-
priority: "Low"
|
|
67
|
-
assignee: "jane.doe"
|
|
68
|
-
labels: ["bug", "resolved"]
|
|
69
|
-
status: "In Progress" # transition to new status
|
|
70
|
-
customfield_10211: "Sprint 2"
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
### Status Transitions
|
|
74
|
-
|
|
75
|
-
- Issue workflow statuses depend on the project's configuration
|
|
76
|
-
- Common transitions: `Open → "In Progress" → "In Review" → "Done" | "Closed"`
|
|
77
|
-
- Use `get_issue` to check current status and `update_issue` with `status` to transition
|
|
78
|
-
- Invalid transitions return an error — check the project's available workflow transitions in Jira
|
|
79
|
-
|
|
80
|
-
## Assign
|
|
81
|
-
|
|
82
|
-
```
|
|
83
|
-
assign_issue
|
|
84
|
-
issueKey: "PROJ-123"
|
|
85
|
-
assignee: "john.doe"
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
`assign_issue` is a dedicated tool. You can also assign via `update_issue` with `assignee`.
|
|
89
|
-
|
|
90
|
-
## Delete
|
|
91
|
-
|
|
92
|
-
```
|
|
93
|
-
delete_issue
|
|
94
|
-
issueKey: "PROJ-123"
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
**Warning**: `delete_issue` is destructive — permanently deletes the issue. Cannot be undone.
|
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
# Project Management
|
|
2
|
-
|
|
3
|
-
## List Projects
|
|
4
|
-
|
|
5
|
-
```
|
|
6
|
-
get_projects
|
|
7
|
-
```
|
|
8
|
-
|
|
9
|
-
Returns all Jira projects the authenticated user can access. Each entry includes `key`, `name`, `projectTypeKey`, `lead`, and `avatarUrls`.
|
|
10
|
-
|
|
11
|
-
Use this to discover available `projectKey` values for issue operations.
|
|
12
|
-
|
|
13
|
-
## Project Details
|
|
14
|
-
|
|
15
|
-
```
|
|
16
|
-
get_project
|
|
17
|
-
projectKey: "PROJ"
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
Returns detailed information: name, key, description, lead, components, versions (releases), project type, and category.
|
|
21
|
-
|
|
22
|
-
Verify a project exists and inspect its components/versions before creating issues:
|
|
23
|
-
|
|
24
|
-
1. `get_project` → check components, versions
|
|
25
|
-
2. `get_issue_types` → check valid issue types
|
|
26
|
-
3. `create_issue` with verified data
|
|
27
|
-
|
|
28
|
-
## Issue Types
|
|
29
|
-
|
|
30
|
-
```
|
|
31
|
-
get_issue_types
|
|
32
|
-
projectKey: "PROJ"
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
Returns available issue types for a project. Each type includes `name`, `id`, `description`, `iconUrl`, and `subtask` flag.
|
|
36
|
-
|
|
37
|
-
Common types across most projects: `Bug`, `Task`, `Story`, `Epic`, `Sub-task`, `Improvement`, `New Feature`.
|
|
38
|
-
|
|
39
|
-
Always call this **before** creating an issue to ensure the `issueType` value is valid for the target project.
|
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: lavish
|
|
3
|
-
description: Turn complex or visual agent responses into rich, reviewable HTML artifacts the user can annotate and send feedback on, using the lavish-axi CLI. Use when about to give a plan, comparison, diagram, table, code diff, report, or anything easier to grasp visually than as prose.
|
|
4
|
-
argument-hint: <what the artifact should show>
|
|
5
|
-
author: Kun Chen (kunchenguid)
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
# Lavish Editor
|
|
9
|
-
|
|
10
|
-
Lavish Editor helps agents turn rich HTML artifacts into collaborative human review surfaces. Whenever you are about to give user a complex response that will be easier to understand via a rich / interactive page, consider using Lavish Editor. First generate an interactive HTML artifact according to user request, then run `npx -y lavish-axi <html-file>` so the user can visually review it, annotate elements or selected text, queue prompts, and send feedback back through `npx -y lavish-axi poll`.
|
|
11
|
-
|
|
12
|
-
You do not need lavish-axi installed globally - invoke it with `npx -y lavish-axi <html-file>`.
|
|
13
|
-
If lavish-axi output shows a follow-up command starting with `lavish-axi`, run it as `npx -y lavish-axi ...` instead.
|
|
14
|
-
|
|
15
|
-
## Request
|
|
16
|
-
|
|
17
|
-
$ARGUMENTS
|
|
18
|
-
|
|
19
|
-
If the request above is non-empty, the user invoked `/lavish` explicitly - build an HTML artifact for that request now, following the workflow below.
|
|
20
|
-
If it is empty, infer what to visualize from the conversation.
|
|
21
|
-
|
|
22
|
-
## When to use
|
|
23
|
-
|
|
24
|
-
Use lavish-axi when the user asks for a visual artifact, HTML explainer, interactive prototype, review surface, product or technical plan, comparison, report, or browser-based feedback loop
|
|
25
|
-
|
|
26
|
-
## Workflow
|
|
27
|
-
|
|
28
|
-
1. Create the HTML artifact (default location `.opencode/output/lavish/<name>.html` in the working directory).
|
|
29
|
-
2. Run `npx -y lavish-axi <html-file>` to open or resume a review session in the browser.
|
|
30
|
-
3. Run `npx -y lavish-axi poll <html-file>` to long-poll for the user's annotations, queued prompts, and browser-reported `layout_warnings`.
|
|
31
|
-
The poll stays silent until the user acts or the real browser reports fresh layout warnings - leave it running, never kill it.
|
|
32
|
-
If your harness limits how long a foreground command may run, run the poll as a background task; if it gets killed or times out anyway, just re-run it - queued feedback is never lost.
|
|
33
|
-
4. If poll returns `layout_warnings`, fix overflow, clipped text, or overlapping unreadable content and re-check before involving the human.
|
|
34
|
-
5. Apply human feedback, then poll again with `--agent-reply "<message>"` to reply in the browser and keep the loop going.
|
|
35
|
-
6. Run `npx -y lavish-axi end <html-file>` when the review is finished.
|
|
36
|
-
|
|
37
|
-
## Visual guidance
|
|
38
|
-
|
|
39
|
-
- Use visual hierarchy to make the most important decisions, risks, tradeoffs, and next actions obvious at a glance
|
|
40
|
-
- Use visual structure such as sections, cards, tables, diagrams, annotated snippets, and side-by-side comparisons instead of long prose
|
|
41
|
-
- Choose typography, spacing, color, and layout deliberately so the artifact has a clear point of view
|
|
42
|
-
- Prevent horizontal overflow at every nesting level: nested grid/flex children also need minmax(0, 1fr) tracks and min-width: 0, especially when badges, labels, or status text use wide pixel or monospace fonts; wrap, truncate, or contain long unbreakable text deliberately
|
|
43
|
-
|
|
44
|
-
## Playbooks
|
|
45
|
-
|
|
46
|
-
Run `npx -y lavish-axi playbook <id>` for focused, detailed guidance on any of these.
|
|
47
|
-
One artifact often combines several playbooks (for example a plan that includes a comparison and a diagram), so read every playbook relevant to your artifact, not just one, for the best quality:
|
|
48
|
-
|
|
49
|
-
- `diagram` - Map relationships, flows, state, and architecture
|
|
50
|
-
- `table` - Turn dense records into scan-friendly review surfaces
|
|
51
|
-
- `comparison` - Show options, tradeoffs, and current vs target behavior
|
|
52
|
-
- `plan` - Explain a product or technical plan before implementation
|
|
53
|
-
- `code` - Render source code, code files, patches, PR diffs, and before/after code inside Lavish artifacts
|
|
54
|
-
- `input` - Must be used when the agent needs to collect user input on decisions, choices, preferences, triage, scope, or other structured feedback from within the artifact
|
|
55
|
-
- `slides` - Create a deliberate presentation when slides are requested
|
|
56
|
-
|
|
57
|
-
## Commands & rules
|
|
58
|
-
|
|
59
|
-
- Run `npx -y lavish-axi <html-file>` to open or resume a Lavish Editor session
|
|
60
|
-
- Unless the user specifies another location, create HTML artifacts in the current working directory under `.opencode/output/lavish/`
|
|
61
|
-
- Lavish serves the html file through a local express.js server. If your html needs to reference other filesystem assets such as images, CSS, fonts, and local scripts, copy them into the same directory as the HTML file, then reference them with relative paths from that directory. Never prepend `/` to those asset paths - root paths won't work
|
|
62
|
-
- Run `npx -y lavish-axi poll <html-file>` to wait for user feedback or browser-reported layout_warnings. It long-polls and stays silent until the user sends feedback, ends the session, or the real browser reports fresh layout_warnings, so leave it running - never kill it. Fix layout_warnings before involving the human. If your harness limits how long a foreground command may run, run the poll as a background task; if it gets killed or times out anyway, just re-run it - queued feedback is never lost
|
|
63
|
-
- Run `npx -y lavish-axi end <html-file>` to end a session
|
|
64
|
-
- Run `npx -y lavish-axi stop` to shut down the background server (it also self-stops when idle or after the last session ends with nothing connected)
|
|
65
|
-
- Run `npx -y lavish-axi playbook <playbook_id>` for focused artifact guidance. One artifact often combines several playbooks (for example a plan that includes a comparison and a diagram), so read every playbook relevant to the artifact, not just one, for the best quality
|
|
66
|
-
- Lavish does not auto-inject any design system - artifacts stay portable so they render identically when opened directly without lavish-axi running. Before writing any HTML, decide the design direction in this strict priority order, and only move to the next step when the current one truly yields nothing: (1) if the user asked for a specific look or named design system, use that; (2) otherwise you must first inspect the project the artifact is about - the subject or product whose content or UI it represents, which may differ from your current working directory - and match that project's design system: Tailwind or theme config, shared CSS variables or design tokens, component library, brand assets, or existing styled pages. If the artifact previews, proposes, or mocks a specific app's UI, render it in that app's own design system so it faithfully shows the product, even when you are running in a different repo; (3) only when both steps come up empty, use the Lavish-recommended Tailwind CSS browser runtime v4 + DaisyUI v5, available via CDN - run `npx -y lavish-axi design` for a copy-pasteable CDN snippet plus component reference, and prefer that CDN snippet over hand-writing styles unless explicitly instructed otherwise by the user. When you deliver the artifact, state which of the three design sources you used and why.
|
|
67
|
-
- Use lavish-axi when the user asks for a visual artifact, HTML explainer, interactive prototype, review surface, product or technical plan, comparison, report, or browser-based feedback loop
|
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
# Lavish Examples
|
|
2
|
-
|
|
3
|
-
## Example 1: Architecture Diagram
|
|
4
|
-
|
|
5
|
-
Visualize a proposed microservices migration for team review. Good agent behavior:
|
|
6
|
-
|
|
7
|
-
- Generate an HTML artifact with a clear SVG or Mermaid diagram showing the current monolith, proposed services, and data flow arrows.
|
|
8
|
-
- Use color coding: blue for existing components, green for new services, orange for shared infrastructure.
|
|
9
|
-
- Include a legend and numbered annotations explaining each architectural decision.
|
|
10
|
-
- Annotate key interfaces and data contracts at each boundary.
|
|
11
|
-
- Run `npx -y lavish-axi <html-file>` to let the team review and leave feedback on specific elements.
|
|
12
|
-
|
|
13
|
-
## Example 2: Code Diff Comparison
|
|
14
|
-
|
|
15
|
-
Present a side-by-side comparison of refactored code for review. Good agent behavior:
|
|
16
|
-
|
|
17
|
-
- Generate an HTML artifact with two panels showing before and after code with syntax highlighting.
|
|
18
|
-
- Highlight changed lines in yellow, added lines in green, removed lines in red.
|
|
19
|
-
- Add inline annotations explaining why each change was made.
|
|
20
|
-
- Include a summary section at the top listing the number of files changed, lines added, and lines removed.
|
|
21
|
-
- Run `npx -y lavish-axi <html-file>` so reviewers can annotate specific code sections.
|
|
22
|
-
|
|
23
|
-
## Example 3: Performance Benchmark Report
|
|
24
|
-
|
|
25
|
-
Display benchmark results comparing caching strategies. Good agent behavior:
|
|
26
|
-
|
|
27
|
-
- Generate an HTML artifact with a bar chart comparing response times across strategies (no cache, Redis, in-memory, database).
|
|
28
|
-
- Include a table with exact measurements: p50, p95, p99 latency, throughput, and memory usage.
|
|
29
|
-
- Add a recommendation section with the preferred strategy highlighted and a rationale.
|
|
30
|
-
- Include interactive tooltips showing sample size and confidence intervals.
|
|
31
|
-
- Run `npx -y lavish-axi <html-file>` so the team can annotate concerns or ask questions about specific benchmarks.
|