@mohammadhprp/system-prompt 0.10.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +35 -0
- package/bin/system-prompt.js +8 -0
- package/framework/README.md +163 -0
- package/framework/agents/README.md +49 -0
- package/framework/agents/backend-architect.md +146 -0
- package/framework/agents/researcher.md +79 -0
- package/framework/agents/reviewer.md +183 -0
- package/framework/agents/security-auditor.md +131 -0
- package/framework/commands/README.md +43 -0
- package/framework/commands/changelog.md +44 -0
- package/framework/commands/commit.md +31 -0
- package/framework/commands/learn.md +24 -0
- package/framework/commands/mr.md +46 -0
- package/framework/commands/pr.md +39 -0
- package/framework/commands/release.md +34 -0
- package/framework/commands/review.md +24 -0
- package/framework/commands/summarize-changes.md +49 -0
- package/framework/mcps/README.md +78 -0
- package/framework/mcps/excalidraw/README.md +37 -0
- package/framework/mcps/excalidraw/capabilities.md +54 -0
- package/framework/mcps/excalidraw/configs/opencode.json +8 -0
- package/framework/mcps/excalidraw/install.md +92 -0
- package/framework/mcps/excalidraw/troubleshooting.md +67 -0
- package/framework/mcps/figma-mcp-go/README.md +51 -0
- package/framework/mcps/figma-mcp-go/capabilities.md +190 -0
- package/framework/mcps/figma-mcp-go/configs/opencode.json +9 -0
- package/framework/mcps/figma-mcp-go/install.md +74 -0
- package/framework/mcps/figma-mcp-go/troubleshooting.md +99 -0
- package/framework/mcps/github-mcp/README.md +51 -0
- package/framework/mcps/github-mcp/capabilities.md +83 -0
- package/framework/mcps/github-mcp/configs/.env.example +1 -0
- package/framework/mcps/github-mcp/configs/opencode.json +13 -0
- package/framework/mcps/github-mcp/install.md +60 -0
- package/framework/mcps/github-mcp/troubleshooting.md +79 -0
- package/framework/mcps/gitlab-mcp/README.md +54 -0
- package/framework/mcps/gitlab-mcp/capabilities.md +216 -0
- package/framework/mcps/gitlab-mcp/configs/.env.example +2 -0
- package/framework/mcps/gitlab-mcp/configs/opencode.json +13 -0
- package/framework/mcps/gitlab-mcp/install.md +99 -0
- package/framework/mcps/gitlab-mcp/troubleshooting.md +116 -0
- package/framework/mcps/jira-mcp/README.md +53 -0
- package/framework/mcps/jira-mcp/capabilities.md +79 -0
- package/framework/mcps/jira-mcp/configs/.env.example +2 -0
- package/framework/mcps/jira-mcp/configs/opencode.json +13 -0
- package/framework/mcps/jira-mcp/install.md +94 -0
- package/framework/mcps/jira-mcp/troubleshooting.md +113 -0
- package/framework/mcps/laravel-boost/README.md +53 -0
- package/framework/mcps/laravel-boost/capabilities.md +92 -0
- package/framework/mcps/laravel-boost/configs/opencode.json +9 -0
- package/framework/mcps/laravel-boost/install.md +106 -0
- package/framework/mcps/laravel-boost/troubleshooting.md +119 -0
- package/framework/mcps/notion-mcp/README.md +58 -0
- package/framework/mcps/notion-mcp/capabilities.md +118 -0
- package/framework/mcps/notion-mcp/configs/opencode.json +9 -0
- package/framework/mcps/notion-mcp/install.md +70 -0
- package/framework/mcps/notion-mcp/troubleshooting.md +95 -0
- package/framework/mcps/playwright-mcp/README.md +50 -0
- package/framework/mcps/playwright-mcp/capabilities.md +149 -0
- package/framework/mcps/playwright-mcp/configs/opencode.json +9 -0
- package/framework/mcps/playwright-mcp/install.md +136 -0
- package/framework/mcps/playwright-mcp/troubleshooting.md +154 -0
- package/framework/mcps/supabase-mcp/README.md +66 -0
- package/framework/mcps/supabase-mcp/capabilities.md +127 -0
- package/framework/mcps/supabase-mcp/configs/opencode.json +9 -0
- package/framework/mcps/supabase-mcp/install.md +85 -0
- package/framework/mcps/supabase-mcp/troubleshooting.md +113 -0
- package/framework/memory/README.md +17 -0
- package/framework/memory/codebase-insights.md +6 -0
- package/framework/memory/user-preferences.md +5 -0
- package/framework/modes/README.md +52 -0
- package/framework/modes/audit.md +88 -0
- package/framework/plugins/README.md +65 -0
- package/framework/plugins/opencode-goal-plugin/README.md +45 -0
- package/framework/plugins/opencode-goal-plugin/capabilities.md +127 -0
- package/framework/plugins/opencode-goal-plugin/install.md +71 -0
- package/framework/plugins/opencode-goal-plugin/troubleshooting.md +112 -0
- package/framework/plugins/ponytail/README.md +44 -0
- package/framework/plugins/ponytail/capabilities.md +112 -0
- package/framework/plugins/ponytail/install.md +77 -0
- package/framework/plugins/ponytail/troubleshooting.md +116 -0
- package/framework/references/standards/api.md +44 -0
- package/framework/references/standards/architecture.md +43 -0
- package/framework/references/standards/database.md +43 -0
- package/framework/references/standards/debugging.md +44 -0
- package/framework/references/standards/documentation.md +43 -0
- package/framework/references/standards/logging.md +43 -0
- package/framework/references/standards/naming.md +43 -0
- package/framework/references/standards/observability.md +43 -0
- package/framework/references/standards/performance.md +43 -0
- package/framework/references/standards/pull-requests.md +43 -0
- package/framework/references/standards/security.md +43 -0
- package/framework/references/standards/testing.md +43 -0
- package/framework/references/templates/adr.md +28 -0
- package/framework/references/templates/api-spec.md +56 -0
- package/framework/references/templates/design-document.md +39 -0
- package/framework/references/templates/incident-report.md +38 -0
- package/framework/references/templates/postmortem.md +41 -0
- package/framework/references/templates/pull-request.md +34 -0
- package/framework/references/templates/runbook.md +48 -0
- package/framework/references/templates/task.md +27 -0
- package/framework/skills/README.md +68 -0
- package/framework/skills/agent-browser/SKILL.md +51 -0
- package/framework/skills/backend-best-practices/SKILL.md +136 -0
- package/framework/skills/backend-best-practices/examples.md +31 -0
- package/framework/skills/backend-best-practices/references/api-design.md +79 -0
- package/framework/skills/backend-best-practices/references/architecture-review.md +77 -0
- package/framework/skills/backend-best-practices/references/database-design.md +78 -0
- package/framework/skills/backend-best-practices/references/debugging.md +76 -0
- package/framework/skills/backend-best-practices/references/observability.md +78 -0
- package/framework/skills/backend-best-practices/references/performance.md +78 -0
- package/framework/skills/backend-best-practices/references/refactoring.md +77 -0
- package/framework/skills/backend-best-practices/references/security.md +80 -0
- package/framework/skills/backend-best-practices/references/testing.md +77 -0
- package/framework/skills/backend-engineer/SKILL.md +76 -0
- package/framework/skills/backend-engineer/examples.md +31 -0
- package/framework/skills/brainstorming/SKILL.md +159 -0
- package/framework/skills/brainstorming/examples.md +49 -0
- package/framework/skills/brainstorming/scripts/frame-template.html +213 -0
- package/framework/skills/brainstorming/scripts/helper.js +167 -0
- package/framework/skills/brainstorming/scripts/server.cjs +723 -0
- package/framework/skills/brainstorming/scripts/start-server.sh +209 -0
- package/framework/skills/brainstorming/scripts/stop-server.sh +120 -0
- package/framework/skills/brainstorming/visual-companion.md +291 -0
- package/framework/skills/brand-guidelines/LICENSE.txt +202 -0
- package/framework/skills/brand-guidelines/SKILL.md +73 -0
- package/framework/skills/code-review/SKILL.md +72 -0
- package/framework/skills/code-review/examples.md +31 -0
- package/framework/skills/design/SKILL.md +399 -0
- package/framework/skills/design/examples.md +34 -0
- package/framework/skills/diagram-design/SKILL.md +485 -0
- package/framework/skills/diagram-design/assets/example-architecture-dark.html +180 -0
- package/framework/skills/diagram-design/assets/example-architecture-full.html +192 -0
- package/framework/skills/diagram-design/assets/example-architecture.html +181 -0
- package/framework/skills/diagram-design/assets/example-bar-dark.html +127 -0
- package/framework/skills/diagram-design/assets/example-bar-full.html +103 -0
- package/framework/skills/diagram-design/assets/example-bar.html +127 -0
- package/framework/skills/diagram-design/assets/example-data-flow-dark.html +143 -0
- package/framework/skills/diagram-design/assets/example-data-flow-full.html +185 -0
- package/framework/skills/diagram-design/assets/example-data-flow.html +143 -0
- package/framework/skills/diagram-design/assets/example-datalake-dark.html +241 -0
- package/framework/skills/diagram-design/assets/example-datalake-full.html +246 -0
- package/framework/skills/diagram-design/assets/example-datalake.html +267 -0
- package/framework/skills/diagram-design/assets/example-dp-integration-dark.html +78 -0
- package/framework/skills/diagram-design/assets/example-dp-integration-full.html +88 -0
- package/framework/skills/diagram-design/assets/example-dp-integration.html +78 -0
- package/framework/skills/diagram-design/assets/example-dp-security-matrix-dark.html +31 -0
- package/framework/skills/diagram-design/assets/example-dp-security-matrix-full.html +32 -0
- package/framework/skills/diagram-design/assets/example-dp-security-matrix.html +88 -0
- package/framework/skills/diagram-design/assets/example-er-dark.html +200 -0
- package/framework/skills/diagram-design/assets/example-er-full.html +203 -0
- package/framework/skills/diagram-design/assets/example-er.html +200 -0
- package/framework/skills/diagram-design/assets/example-flowchart-dark.html +154 -0
- package/framework/skills/diagram-design/assets/example-flowchart-full.html +157 -0
- package/framework/skills/diagram-design/assets/example-flowchart.html +154 -0
- package/framework/skills/diagram-design/assets/example-gantt-dark.html +135 -0
- package/framework/skills/diagram-design/assets/example-gantt-full.html +125 -0
- package/framework/skills/diagram-design/assets/example-gantt.html +135 -0
- package/framework/skills/diagram-design/assets/example-high-level-dark.html +249 -0
- package/framework/skills/diagram-design/assets/example-high-level-full.html +245 -0
- package/framework/skills/diagram-design/assets/example-high-level-vertical-dark.html +272 -0
- package/framework/skills/diagram-design/assets/example-high-level-vertical-full.html +250 -0
- package/framework/skills/diagram-design/assets/example-high-level-vertical.html +323 -0
- package/framework/skills/diagram-design/assets/example-high-level.html +299 -0
- package/framework/skills/diagram-design/assets/example-it-state-dark.html +90 -0
- package/framework/skills/diagram-design/assets/example-it-state-full.html +69 -0
- package/framework/skills/diagram-design/assets/example-it-state.html +128 -0
- package/framework/skills/diagram-design/assets/example-layers-dark.html +121 -0
- package/framework/skills/diagram-design/assets/example-layers-full.html +124 -0
- package/framework/skills/diagram-design/assets/example-layers.html +121 -0
- package/framework/skills/diagram-design/assets/example-line-dark.html +109 -0
- package/framework/skills/diagram-design/assets/example-line-full.html +103 -0
- package/framework/skills/diagram-design/assets/example-line.html +109 -0
- package/framework/skills/diagram-design/assets/example-loop-dark.html +100 -0
- package/framework/skills/diagram-design/assets/example-loop-full.html +137 -0
- package/framework/skills/diagram-design/assets/example-loop-terminal.html +347 -0
- package/framework/skills/diagram-design/assets/example-loop.html +100 -0
- package/framework/skills/diagram-design/assets/example-medallion-dark.html +159 -0
- package/framework/skills/diagram-design/assets/example-medallion-full.html +201 -0
- package/framework/skills/diagram-design/assets/example-medallion.html +159 -0
- package/framework/skills/diagram-design/assets/example-nested-dark.html +130 -0
- package/framework/skills/diagram-design/assets/example-nested-full.html +133 -0
- package/framework/skills/diagram-design/assets/example-nested.html +134 -0
- package/framework/skills/diagram-design/assets/example-org-chart-dark.html +45 -0
- package/framework/skills/diagram-design/assets/example-org-chart-full.html +45 -0
- package/framework/skills/diagram-design/assets/example-org-chart.html +45 -0
- package/framework/skills/diagram-design/assets/example-process-dark.html +62 -0
- package/framework/skills/diagram-design/assets/example-process-full.html +72 -0
- package/framework/skills/diagram-design/assets/example-process.html +62 -0
- package/framework/skills/diagram-design/assets/example-pyramid-dark.html +117 -0
- package/framework/skills/diagram-design/assets/example-pyramid-full.html +120 -0
- package/framework/skills/diagram-design/assets/example-pyramid.html +117 -0
- package/framework/skills/diagram-design/assets/example-quadrant-consultant.html +164 -0
- package/framework/skills/diagram-design/assets/example-quadrant-dark.html +133 -0
- package/framework/skills/diagram-design/assets/example-quadrant-full.html +136 -0
- package/framework/skills/diagram-design/assets/example-quadrant.html +133 -0
- package/framework/skills/diagram-design/assets/example-radar-dark.html +137 -0
- package/framework/skills/diagram-design/assets/example-radar-full.html +133 -0
- package/framework/skills/diagram-design/assets/example-radar.html +137 -0
- package/framework/skills/diagram-design/assets/example-scatter-dark.html +139 -0
- package/framework/skills/diagram-design/assets/example-scatter-full.html +114 -0
- package/framework/skills/diagram-design/assets/example-scatter.html +139 -0
- package/framework/skills/diagram-design/assets/example-sequence-dark.html +220 -0
- package/framework/skills/diagram-design/assets/example-sequence-full.html +386 -0
- package/framework/skills/diagram-design/assets/example-sequence.html +220 -0
- package/framework/skills/diagram-design/assets/example-state-dark.html +145 -0
- package/framework/skills/diagram-design/assets/example-state-full.html +148 -0
- package/framework/skills/diagram-design/assets/example-state.html +145 -0
- package/framework/skills/diagram-design/assets/example-swimlane-dark.html +170 -0
- package/framework/skills/diagram-design/assets/example-swimlane-full.html +173 -0
- package/framework/skills/diagram-design/assets/example-swimlane.html +170 -0
- package/framework/skills/diagram-design/assets/example-timeline-dark.html +133 -0
- package/framework/skills/diagram-design/assets/example-timeline-full.html +136 -0
- package/framework/skills/diagram-design/assets/example-timeline.html +133 -0
- package/framework/skills/diagram-design/assets/example-tree-dark.html +171 -0
- package/framework/skills/diagram-design/assets/example-tree-full.html +174 -0
- package/framework/skills/diagram-design/assets/example-tree.html +171 -0
- package/framework/skills/diagram-design/assets/example-venn-dark.html +130 -0
- package/framework/skills/diagram-design/assets/example-venn-full.html +133 -0
- package/framework/skills/diagram-design/assets/example-venn.html +108 -0
- package/framework/skills/diagram-design/assets/icons.html +230 -0
- package/framework/skills/diagram-design/assets/index.html +333 -0
- package/framework/skills/diagram-design/assets/template-dark.html +82 -0
- package/framework/skills/diagram-design/assets/template-full.html +410 -0
- package/framework/skills/diagram-design/assets/template-terminal.html +170 -0
- package/framework/skills/diagram-design/assets/template.html +83 -0
- package/framework/skills/diagram-design/references/export.md +107 -0
- package/framework/skills/diagram-design/references/onboarding.md +268 -0
- package/framework/skills/diagram-design/references/primitive-annotation.md +36 -0
- package/framework/skills/diagram-design/references/primitive-icons.md +821 -0
- package/framework/skills/diagram-design/references/primitive-sketchy.md +43 -0
- package/framework/skills/diagram-design/references/primitive-terminal.md +76 -0
- package/framework/skills/diagram-design/references/style-guide.md +139 -0
- package/framework/skills/diagram-design/references/type-architecture.md +78 -0
- package/framework/skills/diagram-design/references/type-bar.md +48 -0
- package/framework/skills/diagram-design/references/type-data-flow.md +374 -0
- package/framework/skills/diagram-design/references/type-dp-integration.md +410 -0
- package/framework/skills/diagram-design/references/type-dp-security-matrix.md +379 -0
- package/framework/skills/diagram-design/references/type-er.md +23 -0
- package/framework/skills/diagram-design/references/type-flowchart.md +23 -0
- package/framework/skills/diagram-design/references/type-gantt.md +45 -0
- package/framework/skills/diagram-design/references/type-high-level.md +458 -0
- package/framework/skills/diagram-design/references/type-it-state.md +470 -0
- package/framework/skills/diagram-design/references/type-layers.md +26 -0
- package/framework/skills/diagram-design/references/type-line.md +44 -0
- package/framework/skills/diagram-design/references/type-loop.md +223 -0
- package/framework/skills/diagram-design/references/type-medallion.md +356 -0
- package/framework/skills/diagram-design/references/type-nested.md +22 -0
- package/framework/skills/diagram-design/references/type-org-chart.md +44 -0
- package/framework/skills/diagram-design/references/type-process.md +495 -0
- package/framework/skills/diagram-design/references/type-pyramid.md +33 -0
- package/framework/skills/diagram-design/references/type-quadrant.md +81 -0
- package/framework/skills/diagram-design/references/type-radar.md +80 -0
- package/framework/skills/diagram-design/references/type-scatter.md +39 -0
- package/framework/skills/diagram-design/references/type-sequence.md +35 -0
- package/framework/skills/diagram-design/references/type-state.md +21 -0
- package/framework/skills/diagram-design/references/type-swimlane.md +20 -0
- package/framework/skills/diagram-design/references/type-timeline.md +20 -0
- package/framework/skills/diagram-design/references/type-tree.md +24 -0
- package/framework/skills/diagram-design/references/type-venn.md +26 -0
- package/framework/skills/documentation/SKILL.md +74 -0
- package/framework/skills/documentation/examples.md +31 -0
- package/framework/skills/find-skills/SKILL.md +141 -0
- package/framework/skills/find-skills/examples.md +35 -0
- package/framework/skills/gitlab-mcp/SKILL.md +83 -0
- package/framework/skills/gitlab-mcp/examples.md +31 -0
- package/framework/skills/gitlab-mcp/references/code-review.md +110 -0
- package/framework/skills/gitlab-mcp/references/issues.md +141 -0
- package/framework/skills/gitlab-mcp/references/merge-requests.md +120 -0
- package/framework/skills/gitlab-mcp/references/pipelines.md +67 -0
- package/framework/skills/gitlab-mcp/references/search.md +17 -0
- package/framework/skills/gitlab-mcp/references/webhooks.md +32 -0
- package/framework/skills/gitlab-mcp/references/work-items.md +50 -0
- package/framework/skills/jira-mcp/SKILL.md +57 -0
- package/framework/skills/jira-mcp/examples.md +31 -0
- package/framework/skills/jira-mcp/references/comments.md +27 -0
- package/framework/skills/jira-mcp/references/issues.md +97 -0
- package/framework/skills/jira-mcp/references/projects.md +39 -0
- package/framework/skills/laravel-best-practices/SKILL.md +229 -0
- package/framework/skills/laravel-best-practices/examples.md +31 -0
- package/framework/skills/laravel-best-practices/references/advanced-queries.md +106 -0
- package/framework/skills/laravel-best-practices/references/architecture.md +202 -0
- package/framework/skills/laravel-best-practices/references/blade-views.md +36 -0
- package/framework/skills/laravel-best-practices/references/caching.md +70 -0
- package/framework/skills/laravel-best-practices/references/collections.md +44 -0
- package/framework/skills/laravel-best-practices/references/config.md +73 -0
- package/framework/skills/laravel-best-practices/references/db-performance.md +192 -0
- package/framework/skills/laravel-best-practices/references/eloquent.md +148 -0
- package/framework/skills/laravel-best-practices/references/error-handling.md +72 -0
- package/framework/skills/laravel-best-practices/references/events-notifications.md +52 -0
- package/framework/skills/laravel-best-practices/references/http-client.md +160 -0
- package/framework/skills/laravel-best-practices/references/mail.md +27 -0
- package/framework/skills/laravel-best-practices/references/migrations.md +121 -0
- package/framework/skills/laravel-best-practices/references/passport.md +197 -0
- package/framework/skills/laravel-best-practices/references/pennant.md +61 -0
- package/framework/skills/laravel-best-practices/references/pest-testing.md +166 -0
- package/framework/skills/laravel-best-practices/references/pulse.md +196 -0
- package/framework/skills/laravel-best-practices/references/queue-jobs.md +144 -0
- package/framework/skills/laravel-best-practices/references/routing.md +99 -0
- package/framework/skills/laravel-best-practices/references/scheduling.md +39 -0
- package/framework/skills/laravel-best-practices/references/scout.md +176 -0
- package/framework/skills/laravel-best-practices/references/security.md +198 -0
- package/framework/skills/laravel-best-practices/references/spatie-laravel-backup.md +222 -0
- package/framework/skills/laravel-best-practices/references/spatie-laravel-permission.md +272 -0
- package/framework/skills/laravel-best-practices/references/spatie-medialibrary.md +672 -0
- package/framework/skills/laravel-best-practices/references/style.md +125 -0
- package/framework/skills/laravel-best-practices/references/tailwindcss.md +112 -0
- package/framework/skills/laravel-best-practices/references/testing.md +43 -0
- package/framework/skills/laravel-best-practices/references/validation.md +75 -0
- package/framework/skills/lavish/SKILL.md +67 -0
- package/framework/skills/lavish/examples.md +31 -0
- package/framework/skills/notion-mcp/SKILL.md +57 -0
- package/framework/skills/notion-mcp/examples.md +31 -0
- package/framework/skills/notion-mcp/references/comments.md +112 -0
- package/framework/skills/notion-mcp/references/databases.md +193 -0
- package/framework/skills/notion-mcp/references/pages.md +235 -0
- package/framework/skills/skill-creator/LICENSE.txt +202 -0
- package/framework/skills/skill-creator/SKILL.md +485 -0
- package/framework/skills/skill-creator/agents/analyzer.md +274 -0
- package/framework/skills/skill-creator/agents/comparator.md +202 -0
- package/framework/skills/skill-creator/agents/grader.md +223 -0
- package/framework/skills/skill-creator/assets/eval_review.html +146 -0
- package/framework/skills/skill-creator/eval-viewer/generate_review.py +471 -0
- package/framework/skills/skill-creator/eval-viewer/viewer.html +1325 -0
- package/framework/skills/skill-creator/examples.md +31 -0
- package/framework/skills/skill-creator/references/schemas.md +430 -0
- package/framework/skills/skill-creator/scripts/__init__.py +0 -0
- package/framework/skills/skill-creator/scripts/aggregate_benchmark.py +401 -0
- package/framework/skills/skill-creator/scripts/generate_report.py +326 -0
- package/framework/skills/skill-creator/scripts/improve_description.py +247 -0
- package/framework/skills/skill-creator/scripts/package_skill.py +136 -0
- package/framework/skills/skill-creator/scripts/quick_validate.py +103 -0
- package/framework/skills/skill-creator/scripts/run_eval.py +310 -0
- package/framework/skills/skill-creator/scripts/run_loop.py +328 -0
- package/framework/skills/skill-creator/scripts/utils.py +47 -0
- package/framework/styles/README.md +35 -0
- package/framework/styles/linear/DESIGN.md +478 -0
- package/framework/styles/linear/README.md +36 -0
- package/framework/styles/linear/assets/preview.jpg +0 -0
- package/framework/styles/raycast/DESIGN.md +495 -0
- package/framework/styles/raycast/README.md +35 -0
- package/framework/styles/raycast/assets/preview.jpg +0 -0
- package/package.json +33 -0
- package/src/agent-configs.js +96 -0
- package/src/catalog.js +145 -0
- package/src/cli.js +254 -0
- package/src/installer.js +303 -0
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# GitLab MCP Troubleshooting
|
|
2
|
+
|
|
3
|
+
## Server won't start
|
|
4
|
+
|
|
5
|
+
**Problem**
|
|
6
|
+
|
|
7
|
+
The AI client reports that `gitlab` failed to start.
|
|
8
|
+
|
|
9
|
+
**Cause**
|
|
10
|
+
|
|
11
|
+
The client cannot run `zereight-mcp-gitlab`, Node.js is not installed, or the npm package is not installed globally.
|
|
12
|
+
|
|
13
|
+
**Solution**
|
|
14
|
+
|
|
15
|
+
- Run `zereight-mcp-gitlab` manually to verify the server starts.
|
|
16
|
+
- Check Node.js is installed: `node --version` (requires >= 18).
|
|
17
|
+
- Run `npm install -g @zereight/mcp-gitlab` to install globally.
|
|
18
|
+
- If no global install, use `command: "npx"` with `args: ["-y", "@zereight/mcp-gitlab"]` instead.
|
|
19
|
+
|
|
20
|
+
## Authentication errors
|
|
21
|
+
|
|
22
|
+
**Problem**
|
|
23
|
+
|
|
24
|
+
The server starts but returns authentication errors on tool calls.
|
|
25
|
+
|
|
26
|
+
**Cause**
|
|
27
|
+
|
|
28
|
+
The Personal Access Token is missing, expired, or has insufficient scopes.
|
|
29
|
+
|
|
30
|
+
**Solution**
|
|
31
|
+
|
|
32
|
+
- Verify the token is set in `GITLAB_PERSONAL_ACCESS_TOKEN` or passed via `--token`.
|
|
33
|
+
- Confirm the token has the required scopes (`api` for full access, `read_api` for read-only).
|
|
34
|
+
- Generate a new token in GitLab: **Settings → Access Tokens → Personal Access Tokens**.
|
|
35
|
+
- Confirm the API URL is correct: `https://gitlab.com/api/v4` (SaaS) or `https://your-instance/api/v4` (self-hosted).
|
|
36
|
+
|
|
37
|
+
## Configuration errors
|
|
38
|
+
|
|
39
|
+
**Problem**
|
|
40
|
+
|
|
41
|
+
The MCP server is not listed, or the client ignores the config file.
|
|
42
|
+
|
|
43
|
+
**Cause**
|
|
44
|
+
|
|
45
|
+
The config file is in the wrong location, the JSON is invalid, or the client expects a different configuration wrapper.
|
|
46
|
+
|
|
47
|
+
**Solution**
|
|
48
|
+
|
|
49
|
+
- Validate the JSON with `python -m json.tool <file>` or another JSON parser.
|
|
50
|
+
- Confirm the client-specific config location in the client's documentation.
|
|
51
|
+
- Keep the server name as `gitlab`.
|
|
52
|
+
- Ensure environment variables are set correctly in the config.
|
|
53
|
+
|
|
54
|
+
## Permission errors
|
|
55
|
+
|
|
56
|
+
**Problem**
|
|
57
|
+
|
|
58
|
+
Tools return 403 Forbidden or insufficient permissions.
|
|
59
|
+
|
|
60
|
+
**Cause**
|
|
61
|
+
|
|
62
|
+
The authenticated user does not have the required GitLab project or group permissions.
|
|
63
|
+
|
|
64
|
+
**Solution**
|
|
65
|
+
|
|
66
|
+
- Verify the user has at least Developer role in the target project or group.
|
|
67
|
+
- Check if the project is in a subgroup that inherits different permissions.
|
|
68
|
+
- Use `list_projects` to confirm which projects the token can access.
|
|
69
|
+
|
|
70
|
+
## Rate limiting
|
|
71
|
+
|
|
72
|
+
**Problem**
|
|
73
|
+
|
|
74
|
+
Tools return 429 Too Many Requests errors.
|
|
75
|
+
|
|
76
|
+
**Cause**
|
|
77
|
+
|
|
78
|
+
GitLab API rate limits have been exceeded.
|
|
79
|
+
|
|
80
|
+
**Solution**
|
|
81
|
+
|
|
82
|
+
- Reduce the frequency of tool calls.
|
|
83
|
+
- For self-hosted GitLab, check `gitlab.rb` rate limit settings.
|
|
84
|
+
- Wait for the rate limit window to reset before retrying.
|
|
85
|
+
|
|
86
|
+
## Version mismatch
|
|
87
|
+
|
|
88
|
+
**Problem**
|
|
89
|
+
|
|
90
|
+
Some tools are missing or behave differently than documented.
|
|
91
|
+
|
|
92
|
+
**Cause**
|
|
93
|
+
|
|
94
|
+
The installed npm package version is outdated.
|
|
95
|
+
|
|
96
|
+
**Solution**
|
|
97
|
+
|
|
98
|
+
- Update to the latest version: `npm update -g @zereight/mcp-gitlab`.
|
|
99
|
+
- Check the installed version: `npm list -g @zereight/mcp-gitlab`.
|
|
100
|
+
- Refer to the [CHANGELOG](https://github.com/zereight/gitlab-mcp/blob/main/CHANGELOG.md) for breaking changes.
|
|
101
|
+
|
|
102
|
+
## Read-only mode blocking writes
|
|
103
|
+
|
|
104
|
+
**Problem**
|
|
105
|
+
|
|
106
|
+
Write tools return errors when `GITLAB_PERMISSION_MODE=readonly`.
|
|
107
|
+
|
|
108
|
+
**Cause**
|
|
109
|
+
|
|
110
|
+
Read-only mode explicitly blocks all create, update, and delete operations.
|
|
111
|
+
|
|
112
|
+
**Solution**
|
|
113
|
+
|
|
114
|
+
- Set `GITLAB_PERMISSION_MODE=modify` to allow updates while blocking deletes.
|
|
115
|
+
- Set `GITLAB_PERMISSION_MODE=full` for unrestricted access.
|
|
116
|
+
- Use `GITLAB_TOOLS` allow-list to enable specific write tools in read-only mode.
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Jira MCP
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Jira MCP is a Model Context Protocol (MCP) server for interacting with self-hosted Jira instances using Personal Access Token (PAT) authentication. It provides tools for creating, reading, updating, and deleting issues, searching with JQL, managing comments and assignments, and inspecting projects.
|
|
6
|
+
|
|
7
|
+
Official source:
|
|
8
|
+
|
|
9
|
+
- [GitHub: edrich13/mcp-jira-server](https://github.com/edrich13/mcp-jira-server)
|
|
10
|
+
|
|
11
|
+
## Features
|
|
12
|
+
|
|
13
|
+
- Personal Access Token authentication for self-hosted Jira.
|
|
14
|
+
- Create, read, update, and delete Jira issues.
|
|
15
|
+
- Search issues using JQL (Jira Query Language).
|
|
16
|
+
- Add and view comments.
|
|
17
|
+
- Manage issue assignments.
|
|
18
|
+
- List projects and issue types.
|
|
19
|
+
- Transition issues between statuses.
|
|
20
|
+
- Get current user information.
|
|
21
|
+
|
|
22
|
+
## Supported AI Clients
|
|
23
|
+
|
|
24
|
+
Jira MCP works with any MCP-compatible AI client. The server is started via `npx` and communicates over stdio.
|
|
25
|
+
|
|
26
|
+
- OpenCode
|
|
27
|
+
|
|
28
|
+
## When to Use
|
|
29
|
+
|
|
30
|
+
Use Jira MCP when an AI coding agent needs to interact with a self-hosted Jira instance.
|
|
31
|
+
|
|
32
|
+
Good fits:
|
|
33
|
+
|
|
34
|
+
- Creating and updating Jira issues from an AI agent.
|
|
35
|
+
- Searching for issues with JQL queries.
|
|
36
|
+
- Adding comments and managing issue assignments.
|
|
37
|
+
- Inspecting project metadata and issue types.
|
|
38
|
+
- Tracking work and status transitions.
|
|
39
|
+
|
|
40
|
+
Avoid using it with Jira Cloud (SaaS) — this server is designed for self-hosted Jira instances only.
|
|
41
|
+
|
|
42
|
+
## Requirements
|
|
43
|
+
|
|
44
|
+
- Node.js 18 or higher available on `PATH`.
|
|
45
|
+
- A self-hosted Jira instance (e.g., `https://jira.domain.com`).
|
|
46
|
+
- A Jira Personal Access Token with appropriate permissions.
|
|
47
|
+
|
|
48
|
+
## Related Skills
|
|
49
|
+
|
|
50
|
+
Relevant skills in this repository:
|
|
51
|
+
|
|
52
|
+
- [`backend-engineer`](../../skills/backend-engineer/SKILL.md): tracking feature work in Jira.
|
|
53
|
+
- [`backend-best-practices`](../../skills/backend-best-practices/SKILL.md): backend best practices for debugging and testing.
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# Jira MCP Capabilities
|
|
2
|
+
|
|
3
|
+
## What It Can Do
|
|
4
|
+
|
|
5
|
+
12 tools for interacting with self-hosted Jira instances.
|
|
6
|
+
|
|
7
|
+
### Issues
|
|
8
|
+
|
|
9
|
+
| Tool | Description |
|
|
10
|
+
| --- | --- |
|
|
11
|
+
| `jira_get_issue` | Get details of a specific issue by key (e.g. "PROJ-123") |
|
|
12
|
+
| `jira_search_issues` | Search for issues using JQL with optional max results |
|
|
13
|
+
| `jira_create_issue` | Create a new issue with project, summary, type, description, priority, assignee, labels, components, and custom fields |
|
|
14
|
+
| `jira_update_issue` | Update an existing issue — summary, description, assignee, priority, labels, status, and custom fields |
|
|
15
|
+
| `jira_delete_issue` | Delete an issue permanently |
|
|
16
|
+
| `jira_assign_issue` | Assign an issue to a user |
|
|
17
|
+
|
|
18
|
+
### Comments
|
|
19
|
+
|
|
20
|
+
| Tool | Description |
|
|
21
|
+
| --- | --- |
|
|
22
|
+
| `jira_add_comment` | Add a comment to an issue |
|
|
23
|
+
| `jira_get_comments` | Get all comments from an issue |
|
|
24
|
+
|
|
25
|
+
### Projects
|
|
26
|
+
|
|
27
|
+
| Tool | Description |
|
|
28
|
+
| --- | --- |
|
|
29
|
+
| `jira_get_projects` | List all available projects |
|
|
30
|
+
| `jira_get_project` | Get details of a specific project |
|
|
31
|
+
| `jira_get_issue_types` | Get available issue types for a project |
|
|
32
|
+
|
|
33
|
+
### User
|
|
34
|
+
|
|
35
|
+
| Tool | Description |
|
|
36
|
+
| --- | --- |
|
|
37
|
+
| `jira_get_current_user` | Get information about the currently authenticated user |
|
|
38
|
+
|
|
39
|
+
## What It Cannot Do
|
|
40
|
+
|
|
41
|
+
- It does not work with Jira Cloud (SaaS) — designed for self-hosted instances only.
|
|
42
|
+
- It cannot authenticate with OAuth, API tokens, or cookie-based auth — PAT only.
|
|
43
|
+
- It cannot create, update, or delete Jira projects.
|
|
44
|
+
- It cannot manage Jira users, groups, or permissions.
|
|
45
|
+
- It cannot access Jira boards, sprints, or agile features.
|
|
46
|
+
- It cannot attach files to issues.
|
|
47
|
+
- It cannot operate without a valid PAT and accessible Jira instance.
|
|
48
|
+
|
|
49
|
+
## Best Practices
|
|
50
|
+
|
|
51
|
+
- Never commit your PAT to version control. Use environment variables or client config files with restricted permissions.
|
|
52
|
+
- Use tokens with minimal required permissions.
|
|
53
|
+
- Set expiration dates for tokens and rotate them regularly.
|
|
54
|
+
- Use `jira_get_issue_types` before creating issues to confirm valid types for the project.
|
|
55
|
+
- Use `jira_get_current_user` first to verify authentication is working.
|
|
56
|
+
- Use JQL with specific project keys to scope searches and reduce response size.
|
|
57
|
+
- For Jira instances behind SSO proxies, set `JIRA_USER_AGENT` to a whitelisted value.
|
|
58
|
+
|
|
59
|
+
## Common Workflows
|
|
60
|
+
|
|
61
|
+
### Find and update issues
|
|
62
|
+
|
|
63
|
+
1. Call `jira_search_issues` with a JQL query to find relevant issues.
|
|
64
|
+
2. Call `jira_get_issue` on a specific key to read full details.
|
|
65
|
+
3. Call `jira_update_issue` to change status, assignee, or priority.
|
|
66
|
+
4. Call `jira_add_comment` to leave a note about the change.
|
|
67
|
+
|
|
68
|
+
### Create a new issue
|
|
69
|
+
|
|
70
|
+
1. Call `jira_get_projects` to list available projects.
|
|
71
|
+
2. Call `jira_get_issue_types` for the target project.
|
|
72
|
+
3. Call `jira_create_issue` with project key, summary, issue type, and optional fields.
|
|
73
|
+
4. Call `jira_assign_issue` to assign it to a team member.
|
|
74
|
+
|
|
75
|
+
### Track work progress
|
|
76
|
+
|
|
77
|
+
1. Call `jira_search_issues` with `assignee = currentUser() AND status != Done`.
|
|
78
|
+
2. Call `jira_get_issue` on each key to review details.
|
|
79
|
+
3. Call `jira_update_issue` to transition statuses as work progresses.
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# Jira MCP Installation
|
|
2
|
+
|
|
3
|
+
## Requirements
|
|
4
|
+
|
|
5
|
+
- Node.js 18 or higher available on `PATH`.
|
|
6
|
+
- A self-hosted Jira instance.
|
|
7
|
+
- A Jira Personal Access Token.
|
|
8
|
+
- An MCP-compatible AI client.
|
|
9
|
+
|
|
10
|
+
## Creating a Personal Access Token
|
|
11
|
+
|
|
12
|
+
1. Log in to your self-hosted Jira instance.
|
|
13
|
+
2. Click your profile icon → **Profile** or **Account Settings**.
|
|
14
|
+
3. Navigate to **Personal Access Tokens** or **Security**.
|
|
15
|
+
4. Click **Create token**, give it a name, set an expiration date, and copy the token immediately.
|
|
16
|
+
|
|
17
|
+
## Installation
|
|
18
|
+
|
|
19
|
+
The server can be used directly with `npx` — no build step required.
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npx -y mcp-jira-server
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Or install globally:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
npm install -g mcp-jira-server
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Configuration
|
|
32
|
+
|
|
33
|
+
| Field | Value |
|
|
34
|
+
| --- | --- |
|
|
35
|
+
| Server name | `jira` |
|
|
36
|
+
| Command | `npx` (or `mcp-jira-server` if installed globally) |
|
|
37
|
+
| Args | `-y`, `mcp-jira-server` |
|
|
38
|
+
| Env | `JIRA_BASE_URL`, `JIRA_PAT` |
|
|
39
|
+
|
|
40
|
+
### Config file examples
|
|
41
|
+
|
|
42
|
+
Use the examples in [`configs/`](./configs/) as client-specific starting points:
|
|
43
|
+
|
|
44
|
+
| Client | Example | Typical location |
|
|
45
|
+
| --- | --- | --- |
|
|
46
|
+
| OpenCode | [`configs/opencode.json`](./configs/opencode.json) | OpenCode MCP configuration. |
|
|
47
|
+
|
|
48
|
+
### OpenCode
|
|
49
|
+
|
|
50
|
+
Copy [`configs/opencode.json`](./configs/opencode.json) into your OpenCode project root or user config directory, replace the placeholder URL and token, and restart the OpenCode agent.
|
|
51
|
+
|
|
52
|
+
## Verification
|
|
53
|
+
|
|
54
|
+
Run the MCP server command directly:
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
npx -y mcp-jira-server
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Then verify from your AI client:
|
|
61
|
+
|
|
62
|
+
- The `jira` MCP server is listed.
|
|
63
|
+
- The server starts without errors.
|
|
64
|
+
- Tools are visible to the agent.
|
|
65
|
+
|
|
66
|
+
Recommended first prompt:
|
|
67
|
+
|
|
68
|
+
```
|
|
69
|
+
Get my current Jira user information
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Updating
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
npx -y mcp-jira-server@latest
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Or update global install:
|
|
79
|
+
|
|
80
|
+
```bash
|
|
81
|
+
npm update -g mcp-jira-server
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
## Uninstalling
|
|
85
|
+
|
|
86
|
+
1. Remove the MCP entry from AI client configuration files.
|
|
87
|
+
2. Uninstall the package: `npm uninstall -g mcp-jira-server`.
|
|
88
|
+
|
|
89
|
+
## Common Issues
|
|
90
|
+
|
|
91
|
+
- **Server does not start**: run `npx -y mcp-jira-server` manually. Ensure Node.js >= 18 is installed.
|
|
92
|
+
- **Authentication errors**: verify the PAT is valid and not expired. Confirm `JIRA_BASE_URL` has no trailing slash.
|
|
93
|
+
- **Connection refused**: check if the Jira instance is accessible and the URL is correct.
|
|
94
|
+
- **API requests redirect to SSO login**: your Jira may be behind a reverse proxy. Set `JIRA_USER_AGENT` to a whitelisted User-Agent string.
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
# Jira MCP Troubleshooting
|
|
2
|
+
|
|
3
|
+
## Server won't start
|
|
4
|
+
|
|
5
|
+
**Problem**
|
|
6
|
+
|
|
7
|
+
The AI client reports that `jira` failed to start.
|
|
8
|
+
|
|
9
|
+
**Cause**
|
|
10
|
+
|
|
11
|
+
The client cannot run `npx`, Node.js is not installed, or the npm package is unavailable.
|
|
12
|
+
|
|
13
|
+
**Solution**
|
|
14
|
+
|
|
15
|
+
- Run `npx -y mcp-jira-server` manually to verify the server starts.
|
|
16
|
+
- Check Node.js is installed: `node --version` (requires >= 18).
|
|
17
|
+
- Check network access if the package has not been cached locally.
|
|
18
|
+
- Ensure the config file contains the correct command and args.
|
|
19
|
+
|
|
20
|
+
## Authentication errors
|
|
21
|
+
|
|
22
|
+
**Problem**
|
|
23
|
+
|
|
24
|
+
The server starts but returns authentication errors on tool calls.
|
|
25
|
+
|
|
26
|
+
**Cause**
|
|
27
|
+
|
|
28
|
+
The Personal Access Token is missing, expired, or has insufficient permissions.
|
|
29
|
+
|
|
30
|
+
**Solution**
|
|
31
|
+
|
|
32
|
+
- Verify `JIRA_PAT` is set correctly in the environment.
|
|
33
|
+
- Confirm the token has not expired.
|
|
34
|
+
- Generate a new token in Jira if needed.
|
|
35
|
+
- Verify `JIRA_BASE_URL` is correct and has no trailing slash.
|
|
36
|
+
|
|
37
|
+
## Connection refused
|
|
38
|
+
|
|
39
|
+
**Problem**
|
|
40
|
+
|
|
41
|
+
Tools return connection errors.
|
|
42
|
+
|
|
43
|
+
**Cause**
|
|
44
|
+
|
|
45
|
+
The Jira instance is not accessible from the current machine.
|
|
46
|
+
|
|
47
|
+
**Solution**
|
|
48
|
+
|
|
49
|
+
- Verify the Jira URL is reachable: `curl https://jira.domain.com`.
|
|
50
|
+
- Check network connectivity and firewall rules.
|
|
51
|
+
- Confirm the URL format: `https://jira.domain.com` (no trailing slash).
|
|
52
|
+
|
|
53
|
+
## Configuration errors
|
|
54
|
+
|
|
55
|
+
**Problem**
|
|
56
|
+
|
|
57
|
+
The MCP server is not listed, or the client ignores the config file.
|
|
58
|
+
|
|
59
|
+
**Cause**
|
|
60
|
+
|
|
61
|
+
The config file is in the wrong location, the JSON is invalid, or the client expects a different configuration wrapper.
|
|
62
|
+
|
|
63
|
+
**Solution**
|
|
64
|
+
|
|
65
|
+
- Validate the JSON with `python -m json.tool <file>` or another JSON parser.
|
|
66
|
+
- Confirm the client-specific config location in the client's documentation.
|
|
67
|
+
- Keep the server name as `jira`.
|
|
68
|
+
- Ensure environment variables are set correctly in the config.
|
|
69
|
+
|
|
70
|
+
## API requests redirect to SSO login
|
|
71
|
+
|
|
72
|
+
**Problem**
|
|
73
|
+
|
|
74
|
+
API requests return HTML login pages instead of JSON responses despite a valid PAT.
|
|
75
|
+
|
|
76
|
+
**Cause**
|
|
77
|
+
|
|
78
|
+
The Jira instance is behind a reverse proxy (oauth2-proxy, nginx, etc.) that filters requests by User-Agent and redirects API clients to SSO login.
|
|
79
|
+
|
|
80
|
+
**Solution**
|
|
81
|
+
|
|
82
|
+
- Set the `JIRA_USER_AGENT` environment variable to a whitelisted User-Agent string.
|
|
83
|
+
- Contact your system administrator to get the allowed User-Agent value.
|
|
84
|
+
|
|
85
|
+
## "Issue type not found" errors
|
|
86
|
+
|
|
87
|
+
**Problem**
|
|
88
|
+
|
|
89
|
+
Creating an issue fails with "issue type not found".
|
|
90
|
+
|
|
91
|
+
**Cause**
|
|
92
|
+
|
|
93
|
+
The issue type name does not exist in the target project.
|
|
94
|
+
|
|
95
|
+
**Solution**
|
|
96
|
+
|
|
97
|
+
- Call `jira_get_issue_types` with the project key to list valid types.
|
|
98
|
+
- Use an exact match from the returned list.
|
|
99
|
+
|
|
100
|
+
## "Cannot find module" errors
|
|
101
|
+
|
|
102
|
+
**Problem**
|
|
103
|
+
|
|
104
|
+
The server fails with module resolution errors when using a source build.
|
|
105
|
+
|
|
106
|
+
**Cause**
|
|
107
|
+
|
|
108
|
+
Dependencies are not installed or the project is not built.
|
|
109
|
+
|
|
110
|
+
**Solution**
|
|
111
|
+
|
|
112
|
+
- Run `npm install` and `npm run build` in the project directory.
|
|
113
|
+
- Use the `npx` command instead of a local build.
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
# Laravel Boost
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
Laravel Boost is Laravel's first-party MCP server and AI-assistance package for Laravel applications. It gives AI coding agents project-aware Laravel context, local inspection tools, documentation search, generated AI guidelines, and optional agent skills.
|
|
6
|
+
|
|
7
|
+
Official sources:
|
|
8
|
+
|
|
9
|
+
- [Laravel Boost product page](https://laravel.com/ai/boost)
|
|
10
|
+
- [Laravel Boost documentation](https://laravel.com/docs/boost)
|
|
11
|
+
|
|
12
|
+
## Features
|
|
13
|
+
|
|
14
|
+
- Exposes an MCP server from the Laravel application through `php artisan boost:mcp`.
|
|
15
|
+
- Reads PHP, Laravel, database, package, and Eloquent model information.
|
|
16
|
+
- Inspects routes, configuration, logs, browser errors, and database schema.
|
|
17
|
+
- Executes database queries and Tinker code through MCP tools.
|
|
18
|
+
- Searches Laravel's hosted documentation API with package-aware results.
|
|
19
|
+
- Generates AI guidelines and skills for supported Laravel ecosystem packages.
|
|
20
|
+
|
|
21
|
+
## Supported AI Clients
|
|
22
|
+
|
|
23
|
+
Laravel Boost officially documents setup for Cursor, Claude Code, Codex, Gemini CLI, GitHub Copilot in VS Code, and Junie. The MCP server can also be registered manually in other MCP-compatible clients using the documented command and arguments.
|
|
24
|
+
|
|
25
|
+
- OpenCode
|
|
26
|
+
|
|
27
|
+
## When to Use
|
|
28
|
+
|
|
29
|
+
Use Laravel Boost when an AI coding agent is working inside a Laravel application and needs current, project-specific Laravel context.
|
|
30
|
+
|
|
31
|
+
Good fits:
|
|
32
|
+
|
|
33
|
+
- Building or modifying Laravel features.
|
|
34
|
+
- Inspecting routes, models, configuration, logs, or database schema.
|
|
35
|
+
- Asking Laravel-version-specific implementation questions.
|
|
36
|
+
- Upgrading or maintaining Laravel ecosystem packages supported by Boost guidelines or skills.
|
|
37
|
+
|
|
38
|
+
Avoid using it as a generic MCP outside Laravel projects.
|
|
39
|
+
|
|
40
|
+
## Requirements
|
|
41
|
+
|
|
42
|
+
- A Laravel application.
|
|
43
|
+
- PHP and Composer available in the project environment.
|
|
44
|
+
- `laravel/boost` installed as a development dependency.
|
|
45
|
+
- An AI client that supports MCP, or one of the clients Boost can configure during `php artisan boost:install`.
|
|
46
|
+
- Local access to run `php artisan boost:mcp` from the Laravel application root.
|
|
47
|
+
|
|
48
|
+
## Related Skills
|
|
49
|
+
|
|
50
|
+
Relevant skills in this repository:
|
|
51
|
+
|
|
52
|
+
- [`backend-engineer`](../../skills/backend-engineer/SKILL.md): feature work in Laravel applications.
|
|
53
|
+
- [`backend-best-practices`](../../skills/backend-best-practices/SKILL.md): backend best practices for API design, database design, debugging, testing, and security.
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# Laravel Boost Capabilities
|
|
2
|
+
|
|
3
|
+
## What It Can Do
|
|
4
|
+
|
|
5
|
+
### Application information
|
|
6
|
+
|
|
7
|
+
Reads Laravel application details such as PHP version, Laravel version, database engine, installed ecosystem packages, package versions, and Eloquent models.
|
|
8
|
+
|
|
9
|
+
### Database schema inspection
|
|
10
|
+
|
|
11
|
+
Inspects database connections and schema so agents can reason about tables, columns, relationships, and constraints before changing code.
|
|
12
|
+
|
|
13
|
+
### Database queries
|
|
14
|
+
|
|
15
|
+
Executes database queries through the Laravel application environment. Use this carefully because the tool can access real project data when connected to a real database.
|
|
16
|
+
|
|
17
|
+
### Route inspection
|
|
18
|
+
|
|
19
|
+
Inspects application routes so agents can understand controllers, middleware, endpoints, and URL structure.
|
|
20
|
+
|
|
21
|
+
### Artisan command discovery
|
|
22
|
+
|
|
23
|
+
Lists and inspects available Artisan commands so agents can find framework and application commands without guessing.
|
|
24
|
+
|
|
25
|
+
### Tinker execution
|
|
26
|
+
|
|
27
|
+
Runs suggested PHP code through Laravel's runtime context. This is useful for focused inspection and debugging, but it should be treated as code execution with project permissions.
|
|
28
|
+
|
|
29
|
+
### Configuration access
|
|
30
|
+
|
|
31
|
+
Reads configuration keys and values to help agents generate code that matches the application environment.
|
|
32
|
+
|
|
33
|
+
### Documentation search
|
|
34
|
+
|
|
35
|
+
Queries Laravel's hosted documentation API using installed package context. This helps agents use current, version-aware Laravel ecosystem guidance.
|
|
36
|
+
|
|
37
|
+
### Logs and browser errors
|
|
38
|
+
|
|
39
|
+
Reads application logs, browser errors, and recent errors to support debugging workflows.
|
|
40
|
+
|
|
41
|
+
### AI guidelines and skills
|
|
42
|
+
|
|
43
|
+
Generates AI guidelines and optional agent skills for supported Laravel ecosystem packages detected in the project.
|
|
44
|
+
|
|
45
|
+
## What It Cannot Do
|
|
46
|
+
|
|
47
|
+
- It is not a generic MCP for non-Laravel projects.
|
|
48
|
+
- It does not replace human review for database writes, migrations, authorization changes, or production-impacting commands.
|
|
49
|
+
- It does not guarantee that every AI client supports every generated guideline or skill format.
|
|
50
|
+
- It cannot safely infer production intent; agents still need explicit instructions before changing data or running destructive commands.
|
|
51
|
+
- It cannot fix PHP, Composer, extension, container, or database connectivity issues outside the Laravel project environment.
|
|
52
|
+
- It cannot make an unsupported AI client support MCP; unsupported clients require manual configuration or a compatible extension.
|
|
53
|
+
|
|
54
|
+
## Best Practices
|
|
55
|
+
|
|
56
|
+
- Install Boost as a development dependency only.
|
|
57
|
+
- Run the MCP server from the Laravel application root.
|
|
58
|
+
- Use a local or disposable database for agent-assisted exploration whenever possible.
|
|
59
|
+
- Review database query and Tinker tool use before allowing write operations.
|
|
60
|
+
- Keep generated Boost resources current with `php artisan boost:update`.
|
|
61
|
+
- Prefer official Laravel documentation search through Boost when asking Laravel-version-specific questions.
|
|
62
|
+
- Keep client-specific config examples separate even when the JSON schema is the same.
|
|
63
|
+
- Avoid committing generated local agent configuration if it contains machine-specific paths or settings.
|
|
64
|
+
|
|
65
|
+
## Common Workflows
|
|
66
|
+
|
|
67
|
+
### Understand an existing Laravel application
|
|
68
|
+
|
|
69
|
+
1. Ask the agent to inspect application info.
|
|
70
|
+
2. Ask it to inspect routes and models relevant to the task.
|
|
71
|
+
3. Ask it to inspect database schema before proposing code changes.
|
|
72
|
+
4. Ask it to cite the files and Boost findings used in its plan.
|
|
73
|
+
|
|
74
|
+
### Debug a failing request
|
|
75
|
+
|
|
76
|
+
1. Reproduce the issue locally.
|
|
77
|
+
2. Ask the agent to inspect recent logs and browser errors.
|
|
78
|
+
3. Ask it to map the failing route to controller, middleware, model, and database dependencies.
|
|
79
|
+
4. Apply the smallest fix and run regression tests.
|
|
80
|
+
|
|
81
|
+
### Design a Laravel API change
|
|
82
|
+
|
|
83
|
+
1. Use Boost to inspect routes, validation patterns, models, and schema.
|
|
84
|
+
2. Apply this repository's `api-design`, `database-design`, and `testing` skills.
|
|
85
|
+
3. Ask the agent to produce a compatibility and test plan before editing code.
|
|
86
|
+
4. Verify with feature tests and targeted static checks.
|
|
87
|
+
|
|
88
|
+
### Update Laravel ecosystem code
|
|
89
|
+
|
|
90
|
+
1. Run `php artisan boost:update --discover` after dependency changes.
|
|
91
|
+
2. Ask the agent to use Boost documentation search for version-specific guidance.
|
|
92
|
+
3. Keep changes small and verify with the project's test suite.
|