aidevops 2.52.1 → 2.53.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/README.md +1 -1
- package/VERSION +1 -1
- package/aidevops.sh +15 -9
- package/package.json +4 -4
- package/scripts/npm-postinstall.js +6 -7
- package/setup.sh +1 -1
- package/templates/deploy-templates.sh +144 -0
- package/templates/home/.agent/README.md +33 -0
- package/templates/home/AGENTS.md +96 -0
- package/templates/home/git/.agent/README.md +48 -0
- package/templates/home/git/AGENTS.md +97 -0
- package/templates/standard-functions.sh +179 -0
- package/templates/wordpress-performance-workflow.md +217 -0
- package/.agent/AGENTS.md +0 -614
- package/.agent/accounts.md +0 -65
- package/.agent/aidevops/add-new-mcp-to-aidevops.md +0 -456
- package/.agent/aidevops/api-integrations.md +0 -335
- package/.agent/aidevops/architecture.md +0 -510
- package/.agent/aidevops/configs.md +0 -274
- package/.agent/aidevops/docs.md +0 -244
- package/.agent/aidevops/extension.md +0 -311
- package/.agent/aidevops/mcp-integrations.md +0 -340
- package/.agent/aidevops/mcp-troubleshooting.md +0 -162
- package/.agent/aidevops/memory-patterns.md +0 -172
- package/.agent/aidevops/providers.md +0 -217
- package/.agent/aidevops/recommendations.md +0 -321
- package/.agent/aidevops/requirements.md +0 -301
- package/.agent/aidevops/resources.md +0 -214
- package/.agent/aidevops/security-requirements.md +0 -174
- package/.agent/aidevops/security.md +0 -350
- package/.agent/aidevops/service-links.md +0 -400
- package/.agent/aidevops/services.md +0 -357
- package/.agent/aidevops/setup.md +0 -153
- package/.agent/aidevops/troubleshooting.md +0 -389
- package/.agent/aidevops.md +0 -124
- package/.agent/build-plus.md +0 -244
- package/.agent/content/guidelines.md +0 -109
- package/.agent/content.md +0 -87
- package/.agent/health.md +0 -59
- package/.agent/legal.md +0 -59
- package/.agent/loop-state/full-loop.local.md +0 -16
- package/.agent/loop-state/ralph-loop.local.md +0 -10
- package/.agent/marketing.md +0 -440
- package/.agent/memory/README.md +0 -260
- package/.agent/onboarding.md +0 -796
- package/.agent/plan-plus.md +0 -245
- package/.agent/research.md +0 -100
- package/.agent/sales.md +0 -333
- package/.agent/scripts/101domains-helper.sh +0 -701
- package/.agent/scripts/add-missing-returns.sh +0 -140
- package/.agent/scripts/agent-browser-helper.sh +0 -311
- package/.agent/scripts/agno-setup.sh +0 -712
- package/.agent/scripts/ahrefs-mcp-wrapper.js +0 -168
- package/.agent/scripts/aidevops-update-check.sh +0 -71
- package/.agent/scripts/ampcode-cli.sh +0 -522
- package/.agent/scripts/auto-version-bump.sh +0 -156
- package/.agent/scripts/autogen-helper.sh +0 -512
- package/.agent/scripts/beads-sync-helper.sh +0 -596
- package/.agent/scripts/closte-helper.sh +0 -5
- package/.agent/scripts/cloudron-helper.sh +0 -321
- package/.agent/scripts/codacy-cli-chunked.sh +0 -581
- package/.agent/scripts/codacy-cli.sh +0 -442
- package/.agent/scripts/code-audit-helper.sh +0 -5
- package/.agent/scripts/coderabbit-cli.sh +0 -417
- package/.agent/scripts/coderabbit-pro-analysis.sh +0 -238
- package/.agent/scripts/commands/code-simplifier.md +0 -86
- package/.agent/scripts/commands/full-loop.md +0 -246
- package/.agent/scripts/commands/postflight-loop.md +0 -103
- package/.agent/scripts/commands/recall.md +0 -182
- package/.agent/scripts/commands/remember.md +0 -132
- package/.agent/scripts/commands/save-todo.md +0 -175
- package/.agent/scripts/commands/session-review.md +0 -154
- package/.agent/scripts/comprehensive-quality-fix.sh +0 -106
- package/.agent/scripts/context-builder-helper.sh +0 -522
- package/.agent/scripts/coolify-cli-helper.sh +0 -674
- package/.agent/scripts/coolify-helper.sh +0 -380
- package/.agent/scripts/crawl4ai-examples.sh +0 -401
- package/.agent/scripts/crawl4ai-helper.sh +0 -1078
- package/.agent/scripts/crewai-helper.sh +0 -681
- package/.agent/scripts/dev-browser-helper.sh +0 -513
- package/.agent/scripts/dns-helper.sh +0 -396
- package/.agent/scripts/domain-research-helper.sh +0 -917
- package/.agent/scripts/dspy-helper.sh +0 -285
- package/.agent/scripts/dspyground-helper.sh +0 -291
- package/.agent/scripts/eeat-score-helper.sh +0 -1242
- package/.agent/scripts/efficient-return-fix.sh +0 -92
- package/.agent/scripts/extract-opencode-prompts.sh +0 -128
- package/.agent/scripts/find-missing-returns.sh +0 -113
- package/.agent/scripts/fix-auth-headers.sh +0 -104
- package/.agent/scripts/fix-common-strings.sh +0 -254
- package/.agent/scripts/fix-content-type.sh +0 -100
- package/.agent/scripts/fix-error-messages.sh +0 -130
- package/.agent/scripts/fix-misplaced-returns.sh +0 -74
- package/.agent/scripts/fix-remaining-literals.sh +0 -152
- package/.agent/scripts/fix-return-statements.sh +0 -41
- package/.agent/scripts/fix-s131-default-cases.sh +0 -249
- package/.agent/scripts/fix-sc2155-simple.sh +0 -102
- package/.agent/scripts/fix-shellcheck-critical.sh +0 -187
- package/.agent/scripts/fix-string-literals.sh +0 -273
- package/.agent/scripts/full-loop-helper.sh +0 -773
- package/.agent/scripts/generate-opencode-agents.sh +0 -497
- package/.agent/scripts/generate-opencode-commands.sh +0 -1629
- package/.agent/scripts/generate-skills.sh +0 -366
- package/.agent/scripts/git-platforms-helper.sh +0 -640
- package/.agent/scripts/gitea-cli-helper.sh +0 -743
- package/.agent/scripts/github-cli-helper.sh +0 -702
- package/.agent/scripts/gitlab-cli-helper.sh +0 -682
- package/.agent/scripts/gsc-add-user-helper.sh +0 -325
- package/.agent/scripts/gsc-sitemap-helper.sh +0 -678
- package/.agent/scripts/hetzner-helper.sh +0 -485
- package/.agent/scripts/hostinger-helper.sh +0 -229
- package/.agent/scripts/keyword-research-helper.sh +0 -1815
- package/.agent/scripts/langflow-helper.sh +0 -544
- package/.agent/scripts/linkedin-automation.py +0 -241
- package/.agent/scripts/linter-manager.sh +0 -599
- package/.agent/scripts/linters-local.sh +0 -434
- package/.agent/scripts/list-keys-helper.sh +0 -488
- package/.agent/scripts/local-browser-automation.py +0 -339
- package/.agent/scripts/localhost-helper.sh +0 -744
- package/.agent/scripts/loop-common.sh +0 -806
- package/.agent/scripts/mainwp-helper.sh +0 -728
- package/.agent/scripts/markdown-formatter.sh +0 -338
- package/.agent/scripts/markdown-lint-fix.sh +0 -311
- package/.agent/scripts/mass-fix-returns.sh +0 -58
- package/.agent/scripts/mcp-diagnose.sh +0 -167
- package/.agent/scripts/mcp-inspector-helper.sh +0 -449
- package/.agent/scripts/memory-helper.sh +0 -650
- package/.agent/scripts/monitor-code-review.sh +0 -255
- package/.agent/scripts/onboarding-helper.sh +0 -706
- package/.agent/scripts/opencode-github-setup-helper.sh +0 -797
- package/.agent/scripts/opencode-test-helper.sh +0 -213
- package/.agent/scripts/pagespeed-helper.sh +0 -464
- package/.agent/scripts/pandoc-helper.sh +0 -362
- package/.agent/scripts/postflight-check.sh +0 -555
- package/.agent/scripts/pre-commit-hook.sh +0 -259
- package/.agent/scripts/pre-edit-check.sh +0 -169
- package/.agent/scripts/qlty-cli.sh +0 -356
- package/.agent/scripts/quality-cli-manager.sh +0 -525
- package/.agent/scripts/quality-feedback-helper.sh +0 -462
- package/.agent/scripts/quality-fix.sh +0 -263
- package/.agent/scripts/quality-loop-helper.sh +0 -1108
- package/.agent/scripts/ralph-loop-helper.sh +0 -836
- package/.agent/scripts/ralph-upstream-check.sh +0 -341
- package/.agent/scripts/secretlint-helper.sh +0 -847
- package/.agent/scripts/servers-helper.sh +0 -241
- package/.agent/scripts/ses-helper.sh +0 -619
- package/.agent/scripts/session-review-helper.sh +0 -404
- package/.agent/scripts/setup-linters-wizard.sh +0 -379
- package/.agent/scripts/setup-local-api-keys.sh +0 -330
- package/.agent/scripts/setup-mcp-integrations.sh +0 -472
- package/.agent/scripts/shared-constants.sh +0 -246
- package/.agent/scripts/site-crawler-helper.sh +0 -1487
- package/.agent/scripts/snyk-helper.sh +0 -940
- package/.agent/scripts/sonarcloud-autofix.sh +0 -193
- package/.agent/scripts/sonarcloud-cli.sh +0 -191
- package/.agent/scripts/sonarscanner-cli.sh +0 -455
- package/.agent/scripts/spaceship-helper.sh +0 -747
- package/.agent/scripts/stagehand-helper.sh +0 -321
- package/.agent/scripts/stagehand-python-helper.sh +0 -321
- package/.agent/scripts/stagehand-python-setup.sh +0 -441
- package/.agent/scripts/stagehand-setup.sh +0 -439
- package/.agent/scripts/system-cleanup.sh +0 -340
- package/.agent/scripts/terminal-title-helper.sh +0 -388
- package/.agent/scripts/terminal-title-setup.sh +0 -549
- package/.agent/scripts/test-stagehand-both-integration.sh +0 -317
- package/.agent/scripts/test-stagehand-integration.sh +0 -309
- package/.agent/scripts/test-stagehand-python-integration.sh +0 -341
- package/.agent/scripts/todo-ready.sh +0 -263
- package/.agent/scripts/tool-version-check.sh +0 -362
- package/.agent/scripts/toon-helper.sh +0 -469
- package/.agent/scripts/twilio-helper.sh +0 -917
- package/.agent/scripts/updown-helper.sh +0 -279
- package/.agent/scripts/validate-mcp-integrations.sh +0 -250
- package/.agent/scripts/validate-version-consistency.sh +0 -131
- package/.agent/scripts/vaultwarden-helper.sh +0 -597
- package/.agent/scripts/vercel-cli-helper.sh +0 -816
- package/.agent/scripts/verify-mirrors.sh +0 -169
- package/.agent/scripts/version-manager.sh +0 -831
- package/.agent/scripts/webhosting-helper.sh +0 -471
- package/.agent/scripts/webhosting-verify.sh +0 -238
- package/.agent/scripts/wordpress-mcp-helper.sh +0 -508
- package/.agent/scripts/worktree-helper.sh +0 -595
- package/.agent/scripts/worktree-sessions.sh +0 -577
- package/.agent/seo/dataforseo.md +0 -215
- package/.agent/seo/domain-research.md +0 -532
- package/.agent/seo/eeat-score.md +0 -659
- package/.agent/seo/google-search-console.md +0 -366
- package/.agent/seo/gsc-sitemaps.md +0 -282
- package/.agent/seo/keyword-research.md +0 -521
- package/.agent/seo/serper.md +0 -278
- package/.agent/seo/site-crawler.md +0 -387
- package/.agent/seo.md +0 -236
- package/.agent/services/accounting/quickfile.md +0 -159
- package/.agent/services/communications/telfon.md +0 -470
- package/.agent/services/communications/twilio.md +0 -569
- package/.agent/services/crm/fluentcrm.md +0 -449
- package/.agent/services/email/ses.md +0 -399
- package/.agent/services/hosting/101domains.md +0 -378
- package/.agent/services/hosting/closte.md +0 -177
- package/.agent/services/hosting/cloudflare.md +0 -251
- package/.agent/services/hosting/cloudron.md +0 -478
- package/.agent/services/hosting/dns-providers.md +0 -335
- package/.agent/services/hosting/domain-purchasing.md +0 -344
- package/.agent/services/hosting/hetzner.md +0 -327
- package/.agent/services/hosting/hostinger.md +0 -287
- package/.agent/services/hosting/localhost.md +0 -419
- package/.agent/services/hosting/spaceship.md +0 -353
- package/.agent/services/hosting/webhosting.md +0 -330
- package/.agent/social-media.md +0 -69
- package/.agent/templates/plans-template.md +0 -114
- package/.agent/templates/prd-template.md +0 -129
- package/.agent/templates/tasks-template.md +0 -108
- package/.agent/templates/todo-template.md +0 -89
- package/.agent/tools/ai-assistants/agno.md +0 -471
- package/.agent/tools/ai-assistants/capsolver.md +0 -326
- package/.agent/tools/ai-assistants/configuration.md +0 -221
- package/.agent/tools/ai-assistants/overview.md +0 -209
- package/.agent/tools/ai-assistants/status.md +0 -171
- package/.agent/tools/ai-assistants/windsurf.md +0 -193
- package/.agent/tools/ai-orchestration/autogen.md +0 -406
- package/.agent/tools/ai-orchestration/crewai.md +0 -445
- package/.agent/tools/ai-orchestration/langflow.md +0 -405
- package/.agent/tools/ai-orchestration/openprose.md +0 -487
- package/.agent/tools/ai-orchestration/overview.md +0 -362
- package/.agent/tools/ai-orchestration/packaging.md +0 -647
- package/.agent/tools/browser/agent-browser.md +0 -464
- package/.agent/tools/browser/browser-automation.md +0 -400
- package/.agent/tools/browser/chrome-devtools.md +0 -282
- package/.agent/tools/browser/crawl4ai-integration.md +0 -422
- package/.agent/tools/browser/crawl4ai-resources.md +0 -277
- package/.agent/tools/browser/crawl4ai-usage.md +0 -416
- package/.agent/tools/browser/crawl4ai.md +0 -585
- package/.agent/tools/browser/dev-browser.md +0 -341
- package/.agent/tools/browser/pagespeed.md +0 -260
- package/.agent/tools/browser/playwright.md +0 -266
- package/.agent/tools/browser/playwriter.md +0 -310
- package/.agent/tools/browser/stagehand-examples.md +0 -456
- package/.agent/tools/browser/stagehand-python.md +0 -483
- package/.agent/tools/browser/stagehand.md +0 -421
- package/.agent/tools/build-agent/agent-review.md +0 -224
- package/.agent/tools/build-agent/build-agent.md +0 -784
- package/.agent/tools/build-mcp/aidevops-plugin.md +0 -476
- package/.agent/tools/build-mcp/api-wrapper.md +0 -445
- package/.agent/tools/build-mcp/build-mcp.md +0 -240
- package/.agent/tools/build-mcp/deployment.md +0 -401
- package/.agent/tools/build-mcp/server-patterns.md +0 -632
- package/.agent/tools/build-mcp/transports.md +0 -366
- package/.agent/tools/code-review/auditing.md +0 -383
- package/.agent/tools/code-review/automation.md +0 -219
- package/.agent/tools/code-review/best-practices.md +0 -203
- package/.agent/tools/code-review/codacy.md +0 -151
- package/.agent/tools/code-review/code-simplifier.md +0 -174
- package/.agent/tools/code-review/code-standards.md +0 -309
- package/.agent/tools/code-review/coderabbit.md +0 -101
- package/.agent/tools/code-review/management.md +0 -155
- package/.agent/tools/code-review/qlty.md +0 -248
- package/.agent/tools/code-review/secretlint.md +0 -565
- package/.agent/tools/code-review/setup.md +0 -250
- package/.agent/tools/code-review/snyk.md +0 -563
- package/.agent/tools/code-review/tools.md +0 -230
- package/.agent/tools/content/summarize.md +0 -353
- package/.agent/tools/context/augment-context-engine.md +0 -468
- package/.agent/tools/context/context-builder-agent.md +0 -76
- package/.agent/tools/context/context-builder.md +0 -375
- package/.agent/tools/context/context7.md +0 -371
- package/.agent/tools/context/dspy.md +0 -302
- package/.agent/tools/context/dspyground.md +0 -374
- package/.agent/tools/context/llm-tldr.md +0 -219
- package/.agent/tools/context/osgrep.md +0 -488
- package/.agent/tools/context/prompt-optimization.md +0 -338
- package/.agent/tools/context/toon.md +0 -292
- package/.agent/tools/conversion/pandoc.md +0 -304
- package/.agent/tools/credentials/api-key-management.md +0 -154
- package/.agent/tools/credentials/api-key-setup.md +0 -224
- package/.agent/tools/credentials/environment-variables.md +0 -180
- package/.agent/tools/credentials/vaultwarden.md +0 -382
- package/.agent/tools/data-extraction/outscraper.md +0 -974
- package/.agent/tools/deployment/coolify-cli.md +0 -388
- package/.agent/tools/deployment/coolify-setup.md +0 -353
- package/.agent/tools/deployment/coolify.md +0 -345
- package/.agent/tools/deployment/vercel.md +0 -390
- package/.agent/tools/git/authentication.md +0 -132
- package/.agent/tools/git/gitea-cli.md +0 -193
- package/.agent/tools/git/github-actions.md +0 -207
- package/.agent/tools/git/github-cli.md +0 -223
- package/.agent/tools/git/gitlab-cli.md +0 -190
- package/.agent/tools/git/opencode-github-security.md +0 -350
- package/.agent/tools/git/opencode-github.md +0 -328
- package/.agent/tools/git/opencode-gitlab.md +0 -252
- package/.agent/tools/git/security.md +0 -196
- package/.agent/tools/git.md +0 -207
- package/.agent/tools/opencode/oh-my-opencode.md +0 -375
- package/.agent/tools/opencode/opencode-anthropic-auth.md +0 -446
- package/.agent/tools/opencode/opencode.md +0 -651
- package/.agent/tools/social-media/bird.md +0 -437
- package/.agent/tools/task-management/beads.md +0 -336
- package/.agent/tools/terminal/terminal-title.md +0 -251
- package/.agent/tools/ui/shadcn.md +0 -196
- package/.agent/tools/ui/ui-skills.md +0 -115
- package/.agent/tools/wordpress/localwp.md +0 -311
- package/.agent/tools/wordpress/mainwp.md +0 -391
- package/.agent/tools/wordpress/scf.md +0 -527
- package/.agent/tools/wordpress/wp-admin.md +0 -729
- package/.agent/tools/wordpress/wp-dev.md +0 -940
- package/.agent/tools/wordpress/wp-preferred.md +0 -398
- package/.agent/tools/wordpress.md +0 -95
- package/.agent/workflows/branch/bugfix.md +0 -63
- package/.agent/workflows/branch/chore.md +0 -95
- package/.agent/workflows/branch/experiment.md +0 -115
- package/.agent/workflows/branch/feature.md +0 -59
- package/.agent/workflows/branch/hotfix.md +0 -98
- package/.agent/workflows/branch/refactor.md +0 -92
- package/.agent/workflows/branch/release.md +0 -96
- package/.agent/workflows/branch.md +0 -347
- package/.agent/workflows/bug-fixing.md +0 -267
- package/.agent/workflows/changelog.md +0 -129
- package/.agent/workflows/code-audit-remote.md +0 -279
- package/.agent/workflows/conversation-starter.md +0 -69
- package/.agent/workflows/error-feedback.md +0 -578
- package/.agent/workflows/feature-development.md +0 -355
- package/.agent/workflows/git-workflow.md +0 -702
- package/.agent/workflows/multi-repo-workspace.md +0 -268
- package/.agent/workflows/plans.md +0 -709
- package/.agent/workflows/postflight.md +0 -604
- package/.agent/workflows/pr.md +0 -571
- package/.agent/workflows/preflight.md +0 -278
- package/.agent/workflows/ralph-loop.md +0 -773
- package/.agent/workflows/release.md +0 -498
- package/.agent/workflows/session-manager.md +0 -254
- package/.agent/workflows/session-review.md +0 -311
- package/.agent/workflows/sql-migrations.md +0 -631
- package/.agent/workflows/version-bump.md +0 -283
- package/.agent/workflows/wiki-update.md +0 -333
- package/.agent/workflows/worktree.md +0 -477
|
@@ -1,371 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: Real-time library documentation via Context7 MCP
|
|
3
|
-
mode: subagent
|
|
4
|
-
tools:
|
|
5
|
-
read: true
|
|
6
|
-
write: false
|
|
7
|
-
edit: false
|
|
8
|
-
bash: false
|
|
9
|
-
glob: true
|
|
10
|
-
grep: true
|
|
11
|
-
webfetch: true
|
|
12
|
-
task: true
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
# Context7 MCP Setup Guide
|
|
16
|
-
|
|
17
|
-
<!-- AI-CONTEXT-START -->
|
|
18
|
-
|
|
19
|
-
## Quick Reference
|
|
20
|
-
|
|
21
|
-
- **Purpose**: Real-time access to latest library/framework documentation
|
|
22
|
-
- **Command**: `npx -y @context7/mcp-server@latest`
|
|
23
|
-
- **Built into Augment**: No setup needed, tools available directly
|
|
24
|
-
|
|
25
|
-
**MCP Tools**:
|
|
26
|
-
- `resolve-library-id("next.js")` → Returns "/vercel/next.js"
|
|
27
|
-
- `get-library-docs("/vercel/next.js")` → Returns documentation
|
|
28
|
-
- `get-library-docs("/vercel/next.js", topic="routing")` → Topic-specific
|
|
29
|
-
- `get-library-docs("/vercel/next.js", tokens=15000)` → More detail
|
|
30
|
-
|
|
31
|
-
**Common Library IDs**:
|
|
32
|
-
- Frontend: `/vercel/next.js`, `/facebook/react`, `/vuejs/vue`
|
|
33
|
-
- Backend: `/expressjs/express`, `/nestjs/nest`
|
|
34
|
-
- DB/ORM: `/prisma/prisma`, `/supabase/supabase`, `/drizzle-team/drizzle-orm`
|
|
35
|
-
- Tools: `/vitejs/vite`, `/typescript-eslint/typescript-eslint`
|
|
36
|
-
|
|
37
|
-
**Config Location**: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
38
|
-
<!-- AI-CONTEXT-END -->
|
|
39
|
-
|
|
40
|
-
Context7 MCP provides AI assistants with real-time access to the latest documentation for thousands of development tools, frameworks, and libraries.
|
|
41
|
-
|
|
42
|
-
## 🎯 **What is Context7 MCP?**
|
|
43
|
-
|
|
44
|
-
Context7 MCP is a Model Context Protocol server that gives AI assistants access to:
|
|
45
|
-
|
|
46
|
-
- **Latest documentation** for popular development tools and frameworks
|
|
47
|
-
- **Version-specific** documentation and guides
|
|
48
|
-
- **AI-optimized** content format for better understanding
|
|
49
|
-
- **Real-time updates** as libraries and tools evolve
|
|
50
|
-
- **Comprehensive coverage** of the development ecosystem
|
|
51
|
-
|
|
52
|
-
## 🚀 **Benefits for AI-Assisted Development**
|
|
53
|
-
|
|
54
|
-
### **Before Context7 MCP:**
|
|
55
|
-
|
|
56
|
-
- AI assistants work with **outdated training data**
|
|
57
|
-
- **Guessing** at API changes and new features
|
|
58
|
-
- **Inconsistent** information across different versions
|
|
59
|
-
- **Limited** knowledge of recent tools and updates
|
|
60
|
-
|
|
61
|
-
### **After Context7 MCP:**
|
|
62
|
-
|
|
63
|
-
- **Real-time access** to latest documentation
|
|
64
|
-
- **Version-specific** guidance and examples
|
|
65
|
-
- **Accurate** API references and best practices
|
|
66
|
-
- **Comprehensive** coverage of your development stack
|
|
67
|
-
|
|
68
|
-
## 📦 **Installation & Setup**
|
|
69
|
-
|
|
70
|
-
### **Prerequisites:**
|
|
71
|
-
|
|
72
|
-
- **Node.js 18+** installed
|
|
73
|
-
- **npm or npx** available
|
|
74
|
-
- **AI assistant** that supports MCP (Claude Desktop, Cursor, etc.)
|
|
75
|
-
|
|
76
|
-
### **1. Test Context7 MCP Server:**
|
|
77
|
-
|
|
78
|
-
```bash
|
|
79
|
-
# Test the server (no installation needed with npx)
|
|
80
|
-
npx -y @context7/mcp-server@latest --help
|
|
81
|
-
|
|
82
|
-
# This should show the Context7 MCP server help
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
### **2. Add to Your AI Assistant Configuration:**
|
|
86
|
-
|
|
87
|
-
#### **For Claude Desktop:**
|
|
88
|
-
|
|
89
|
-
Edit `~/Library/Application Support/Claude/claude_desktop_config.json`:
|
|
90
|
-
|
|
91
|
-
```json
|
|
92
|
-
{
|
|
93
|
-
"mcpServers": {
|
|
94
|
-
"context7": {
|
|
95
|
-
"command": "npx",
|
|
96
|
-
"args": ["-y", "@context7/mcp-server@latest"],
|
|
97
|
-
"env": {
|
|
98
|
-
"DEBUG": "false"
|
|
99
|
-
}
|
|
100
|
-
}
|
|
101
|
-
}
|
|
102
|
-
}
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
#### **For Cursor IDE:**
|
|
106
|
-
|
|
107
|
-
Create/edit `.cursor/mcp.json` in your project:
|
|
108
|
-
|
|
109
|
-
```json
|
|
110
|
-
{
|
|
111
|
-
"mcpServers": {
|
|
112
|
-
"context7": {
|
|
113
|
-
"command": "npx",
|
|
114
|
-
"args": ["-y", "@context7/mcp-server@latest"]
|
|
115
|
-
}
|
|
116
|
-
}
|
|
117
|
-
}
|
|
118
|
-
```
|
|
119
|
-
|
|
120
|
-
#### **For Augment Agent:**
|
|
121
|
-
|
|
122
|
-
Context7 tools are **built-in** - no additional setup required!
|
|
123
|
-
|
|
124
|
-
- Use `resolve-library-id` tool to find library IDs
|
|
125
|
-
- Use `get-library-docs` tool to fetch documentation
|
|
126
|
-
|
|
127
|
-
### **3. Framework Configuration:**
|
|
128
|
-
|
|
129
|
-
```bash
|
|
130
|
-
# Copy the Context7 MCP configuration template
|
|
131
|
-
cp configs/context7-mcp-config.json.txt configs/context7-mcp-config.json
|
|
132
|
-
|
|
133
|
-
# Edit with your commonly used libraries and preferences
|
|
134
|
-
```
|
|
135
|
-
|
|
136
|
-
## 🔧 **Usage Examples**
|
|
137
|
-
|
|
138
|
-
### **1. Library Resolution:**
|
|
139
|
-
|
|
140
|
-
```bash
|
|
141
|
-
# Always resolve library names first
|
|
142
|
-
resolve-library-id("next.js")
|
|
143
|
-
# Returns: "/vercel/next.js"
|
|
144
|
-
|
|
145
|
-
resolve-library-id("react")
|
|
146
|
-
# Returns: "/facebook/react"
|
|
147
|
-
|
|
148
|
-
resolve-library-id("supabase")
|
|
149
|
-
# Returns: "/supabase/supabase"
|
|
150
|
-
```
|
|
151
|
-
|
|
152
|
-
### **2. Getting Documentation:**
|
|
153
|
-
|
|
154
|
-
```bash
|
|
155
|
-
# Get general documentation
|
|
156
|
-
get-library-docs("/vercel/next.js")
|
|
157
|
-
|
|
158
|
-
# Get topic-specific documentation
|
|
159
|
-
get-library-docs("/vercel/next.js", topic="routing")
|
|
160
|
-
|
|
161
|
-
# Get version-specific documentation
|
|
162
|
-
get-library-docs("/vercel/next.js/v14.3.0-canary.87")
|
|
163
|
-
|
|
164
|
-
# Adjust token limits for more/less detail
|
|
165
|
-
get-library-docs("/facebook/react", tokens=10000)
|
|
166
|
-
```
|
|
167
|
-
|
|
168
|
-
### **3. Common Development Workflows:**
|
|
169
|
-
|
|
170
|
-
#### **Starting a New Project:**
|
|
171
|
-
|
|
172
|
-
```bash
|
|
173
|
-
# Get setup documentation for your stack
|
|
174
|
-
resolve-library-id("next.js") -> get-library-docs("/vercel/next.js", topic="getting-started")
|
|
175
|
-
resolve-library-id("tailwind") -> get-library-docs("/tailwindlabs/tailwindcss", topic="installation")
|
|
176
|
-
resolve-library-id("prisma") -> get-library-docs("/prisma/prisma", topic="setup")
|
|
177
|
-
```
|
|
178
|
-
|
|
179
|
-
#### **Debugging Issues:**
|
|
180
|
-
|
|
181
|
-
```bash
|
|
182
|
-
# Get troubleshooting guides
|
|
183
|
-
get-library-docs("/vercel/next.js", topic="troubleshooting")
|
|
184
|
-
|
|
185
|
-
# Check API changes between versions
|
|
186
|
-
get-library-docs("/facebook/react/v18.2.0")
|
|
187
|
-
get-library-docs("/facebook/react/v18.3.0")
|
|
188
|
-
```
|
|
189
|
-
|
|
190
|
-
#### **Learning New Tools:**
|
|
191
|
-
|
|
192
|
-
```bash
|
|
193
|
-
# Comprehensive documentation for new library
|
|
194
|
-
resolve-library-id("drizzle-orm") -> get-library-docs("/drizzle-team/drizzle-orm")
|
|
195
|
-
|
|
196
|
-
# Get examples and best practices
|
|
197
|
-
get-library-docs("/drizzle-team/drizzle-orm", topic="examples")
|
|
198
|
-
```
|
|
199
|
-
|
|
200
|
-
## 📚 **Common Library Categories**
|
|
201
|
-
|
|
202
|
-
### **Frontend Frameworks:**
|
|
203
|
-
|
|
204
|
-
- `/vercel/next.js` - Next.js React framework
|
|
205
|
-
- `/facebook/react` - React library
|
|
206
|
-
- `/vuejs/vue` - Vue.js framework
|
|
207
|
-
- `/angular/angular` - Angular framework
|
|
208
|
-
- `/sveltejs/svelte` - Svelte framework
|
|
209
|
-
|
|
210
|
-
### **Backend Frameworks:**
|
|
211
|
-
|
|
212
|
-
- `/expressjs/express` - Express.js for Node.js
|
|
213
|
-
- `/nestjs/nest` - NestJS framework
|
|
214
|
-
- `/fastify/fastify` - Fastify web framework
|
|
215
|
-
- `/django/django` - Django Python framework
|
|
216
|
-
- `/flask/flask` - Flask Python framework
|
|
217
|
-
|
|
218
|
-
### **Databases & ORMs:**
|
|
219
|
-
|
|
220
|
-
- `/mongodb/docs` - MongoDB database
|
|
221
|
-
- `/postgres/postgres` - PostgreSQL database
|
|
222
|
-
- `/supabase/supabase` - Supabase platform
|
|
223
|
-
- `/prisma/prisma` - Prisma ORM
|
|
224
|
-
- `/drizzle-team/drizzle-orm` - Drizzle ORM
|
|
225
|
-
|
|
226
|
-
### **Development Tools:**
|
|
227
|
-
|
|
228
|
-
- `/microsoft/vscode` - VS Code editor
|
|
229
|
-
- `/typescript-eslint/typescript-eslint` - TypeScript ESLint
|
|
230
|
-
- `/prettier/prettier` - Code formatter
|
|
231
|
-
- `/vitejs/vite` - Vite build tool
|
|
232
|
-
- `/webpack/webpack` - Webpack bundler
|
|
233
|
-
|
|
234
|
-
### **AI/ML Tools:**
|
|
235
|
-
|
|
236
|
-
- `/openai/openai-node` - OpenAI Node.js SDK
|
|
237
|
-
- `/anthropic/anthropic-sdk-typescript` - Anthropic TypeScript SDK
|
|
238
|
-
- `/langchain-ai/langchainjs` - LangChain JavaScript
|
|
239
|
-
- `/huggingface/transformers.js` - Hugging Face Transformers
|
|
240
|
-
|
|
241
|
-
## 🛠️ **Best Practices**
|
|
242
|
-
|
|
243
|
-
### **Library Resolution:**
|
|
244
|
-
|
|
245
|
-
1. **Always resolve first**: Use `resolve-library-id` before `get-library-docs`
|
|
246
|
-
2. **Use specific names**: "next.js" is better than "nextjs"
|
|
247
|
-
3. **Check alternatives**: Some libraries have multiple valid IDs
|
|
248
|
-
4. **Cache results**: Store resolved IDs for repeated use
|
|
249
|
-
|
|
250
|
-
### **Documentation Retrieval:**
|
|
251
|
-
|
|
252
|
-
1. **Use topics**: Specify topics for focused results (`topic="routing"`)
|
|
253
|
-
2. **Manage tokens**: Adjust token limits based on detail needed
|
|
254
|
-
3. **Version-specific**: Use specific versions when working with older code
|
|
255
|
-
4. **Combine sources**: Get docs from multiple related libraries
|
|
256
|
-
|
|
257
|
-
### **Development Workflow:**
|
|
258
|
-
|
|
259
|
-
1. **Start with docs**: Get documentation before coding
|
|
260
|
-
2. **Reference during development**: Keep docs accessible while coding
|
|
261
|
-
3. **Check for updates**: Regularly verify you're using latest practices
|
|
262
|
-
4. **Validate approaches**: Use docs to verify your implementation approach
|
|
263
|
-
|
|
264
|
-
## 🔍 **Troubleshooting**
|
|
265
|
-
|
|
266
|
-
### **Common Issues:**
|
|
267
|
-
|
|
268
|
-
#### **Library Not Found:**
|
|
269
|
-
|
|
270
|
-
```bash
|
|
271
|
-
# Try different variations
|
|
272
|
-
resolve-library-id("nextjs") # Try without dots
|
|
273
|
-
resolve-library-id("next") # Try shortened name
|
|
274
|
-
resolve-library-id("vercel/next") # Try with org prefix
|
|
275
|
-
```
|
|
276
|
-
|
|
277
|
-
#### **Documentation Seems Outdated:**
|
|
278
|
-
|
|
279
|
-
```bash
|
|
280
|
-
# Check for specific version
|
|
281
|
-
get-library-docs("/vercel/next.js/v14.0.0")
|
|
282
|
-
|
|
283
|
-
# Verify library has moved or been renamed
|
|
284
|
-
resolve-library-id("new-library-name")
|
|
285
|
-
```
|
|
286
|
-
|
|
287
|
-
#### **MCP Server Not Responding:**
|
|
288
|
-
|
|
289
|
-
```bash
|
|
290
|
-
# Test the server directly
|
|
291
|
-
npx -y @context7/mcp-server@latest --version
|
|
292
|
-
|
|
293
|
-
# Check your AI assistant's MCP configuration
|
|
294
|
-
# Restart your AI assistant
|
|
295
|
-
```
|
|
296
|
-
|
|
297
|
-
## 🎯 **Integration with Your Workflow**
|
|
298
|
-
|
|
299
|
-
### **Project Setup:**
|
|
300
|
-
|
|
301
|
-
```bash
|
|
302
|
-
# Create project-specific library list
|
|
303
|
-
echo '["next.js", "tailwind", "prisma", "supabase"]' > .context7-libraries
|
|
304
|
-
|
|
305
|
-
# Get setup docs for all libraries
|
|
306
|
-
for lib in $(cat .context7-libraries); do
|
|
307
|
-
resolve-library-id("$lib") && get-library-docs(result, topic="setup")
|
|
308
|
-
done
|
|
309
|
-
```
|
|
310
|
-
|
|
311
|
-
### **Code Review:**
|
|
312
|
-
|
|
313
|
-
- **Verify best practices** against latest documentation
|
|
314
|
-
- **Check for deprecated** APIs and patterns
|
|
315
|
-
- **Reference migration guides** for version updates
|
|
316
|
-
- **Validate security practices** with official guidelines
|
|
317
|
-
|
|
318
|
-
### **Learning & Development:**
|
|
319
|
-
|
|
320
|
-
- **Explore new libraries** with comprehensive documentation
|
|
321
|
-
- **Understand breaking changes** between versions
|
|
322
|
-
- **Learn best practices** from official examples
|
|
323
|
-
- **Stay updated** with latest features and improvements
|
|
324
|
-
|
|
325
|
-
## 🌟 **Advanced Features**
|
|
326
|
-
|
|
327
|
-
### **Version-Specific Documentation:**
|
|
328
|
-
|
|
329
|
-
```bash
|
|
330
|
-
# Get docs for specific version
|
|
331
|
-
get-library-docs("/vercel/next.js/v13.5.0")
|
|
332
|
-
|
|
333
|
-
# Compare between versions
|
|
334
|
-
get-library-docs("/react-router/react-router/v5.3.0")
|
|
335
|
-
get-library-docs("/react-router/react-router/v6.0.0")
|
|
336
|
-
```
|
|
337
|
-
|
|
338
|
-
### **Topic-Focused Queries:**
|
|
339
|
-
|
|
340
|
-
```bash
|
|
341
|
-
# Get specific topic documentation
|
|
342
|
-
get-library-docs("/vercel/next.js", topic="api-routes")
|
|
343
|
-
get-library-docs("/prisma/prisma", topic="migrations")
|
|
344
|
-
get-library-docs("/supabase/supabase", topic="authentication")
|
|
345
|
-
```
|
|
346
|
-
|
|
347
|
-
### **Token Management:**
|
|
348
|
-
|
|
349
|
-
```bash
|
|
350
|
-
# Brief overview (default: 5000 tokens)
|
|
351
|
-
get-library-docs("/facebook/react")
|
|
352
|
-
|
|
353
|
-
# Detailed documentation (more tokens)
|
|
354
|
-
get-library-docs("/facebook/react", tokens=15000)
|
|
355
|
-
|
|
356
|
-
# Quick reference (fewer tokens)
|
|
357
|
-
get-library-docs("/facebook/react", tokens=2000)
|
|
358
|
-
```
|
|
359
|
-
|
|
360
|
-
## 📈 **Benefits for Your Development**
|
|
361
|
-
|
|
362
|
-
✅ **Always Current** - Documentation is continuously updated
|
|
363
|
-
✅ **Version Aware** - Access docs for specific versions you're using
|
|
364
|
-
✅ **AI Optimized** - Content formatted for better AI understanding
|
|
365
|
-
✅ **Comprehensive** - Covers thousands of popular development tools
|
|
366
|
-
✅ **Fast Access** - Real-time retrieval without manual searching
|
|
367
|
-
✅ **Context Aware** - AI understands your specific development context
|
|
368
|
-
|
|
369
|
-
---
|
|
370
|
-
|
|
371
|
-
**Transform your AI-assisted development with real-time access to the latest documentation!** 🚀📚
|
|
@@ -1,302 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
description: DSPy framework for programmatic LLM optimization
|
|
3
|
-
mode: subagent
|
|
4
|
-
tools:
|
|
5
|
-
read: true
|
|
6
|
-
write: false
|
|
7
|
-
edit: false
|
|
8
|
-
bash: true
|
|
9
|
-
glob: true
|
|
10
|
-
grep: true
|
|
11
|
-
webfetch: true
|
|
12
|
-
task: true
|
|
13
|
-
---
|
|
14
|
-
|
|
15
|
-
# DSPy Integration Guide
|
|
16
|
-
|
|
17
|
-
<!-- AI-CONTEXT-START -->
|
|
18
|
-
|
|
19
|
-
## Quick Reference
|
|
20
|
-
|
|
21
|
-
- DSPy: Framework for algorithmically optimizing LLM prompts and weights
|
|
22
|
-
- Requires: Python 3.8+, OpenAI/Anthropic API key
|
|
23
|
-
- Helper: `./.agent/scripts/dspy-helper.sh install|test|init [project]`
|
|
24
|
-
- Config: `configs/dspy-config.json` (copy from .txt template)
|
|
25
|
-
- Projects: `data/dspy/[project-name]/`
|
|
26
|
-
- Virtual env: `python-env/dspy-env/`
|
|
27
|
-
- Key classes: Signature (define I/O), Module (logic), ChainOfThought (reasoning)
|
|
28
|
-
- Optimizers: BootstrapFewShot (few-shot), COPRO (iterative), MIPRO (multi-stage)
|
|
29
|
-
- API keys: Uses env vars `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`
|
|
30
|
-
<!-- AI-CONTEXT-END -->
|
|
31
|
-
|
|
32
|
-
## Overview
|
|
33
|
-
|
|
34
|
-
DSPy (Declarative Self-improving Python) is a framework for algorithmically optimizing LM prompts and weights. This integration provides seamless access to DSPy's powerful prompt optimization capabilities within the AI DevOps Framework.
|
|
35
|
-
|
|
36
|
-
## 🚀 **Quick Start**
|
|
37
|
-
|
|
38
|
-
### **Prerequisites**
|
|
39
|
-
|
|
40
|
-
- Python 3.8+ installed
|
|
41
|
-
- Virtual environment support
|
|
42
|
-
- OpenAI API key (or other LLM provider)
|
|
43
|
-
|
|
44
|
-
### **Installation**
|
|
45
|
-
|
|
46
|
-
```bash
|
|
47
|
-
# Install DSPy dependencies
|
|
48
|
-
./.agent/scripts/dspy-helper.sh install
|
|
49
|
-
|
|
50
|
-
# Test installation
|
|
51
|
-
./.agent/scripts/dspy-helper.sh test
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
### **Configuration**
|
|
55
|
-
|
|
56
|
-
1. **Copy configuration template:**
|
|
57
|
-
|
|
58
|
-
```bash
|
|
59
|
-
cp configs/dspy-config.json.txt configs/dspy-config.json
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
2. **Edit configuration:**
|
|
63
|
-
|
|
64
|
-
```bash
|
|
65
|
-
# Add your API keys and customize settings
|
|
66
|
-
nano configs/dspy-config.json
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
3. **Set environment variables (if not already set):**
|
|
70
|
-
|
|
71
|
-
```bash
|
|
72
|
-
# DSPy automatically uses your terminal session's API keys
|
|
73
|
-
export OPENAI_API_KEY="your-api-key-here"
|
|
74
|
-
export ANTHROPIC_API_KEY="your-anthropic-key-here"
|
|
75
|
-
|
|
76
|
-
# Check current environment
|
|
77
|
-
echo $OPENAI_API_KEY
|
|
78
|
-
```
|
|
79
|
-
|
|
80
|
-
**Note**: DSPy prioritizes environment variables over config file values, so your existing terminal session API keys will be used automatically!
|
|
81
|
-
|
|
82
|
-
## 📁 **Project Structure**
|
|
83
|
-
|
|
84
|
-
```text
|
|
85
|
-
aidevops/
|
|
86
|
-
├── .agent/scripts/dspy-helper.sh # DSPy management script
|
|
87
|
-
├── configs/dspy-config.json # DSPy configuration
|
|
88
|
-
├── python-env/dspy-env/ # Python virtual environment
|
|
89
|
-
├── data/dspy/ # DSPy projects and datasets
|
|
90
|
-
├── logs/ # DSPy logs
|
|
91
|
-
└── requirements.txt # Python dependencies
|
|
92
|
-
```
|
|
93
|
-
|
|
94
|
-
## 🛠️ **Usage**
|
|
95
|
-
|
|
96
|
-
### **Initialize New Project**
|
|
97
|
-
|
|
98
|
-
```bash
|
|
99
|
-
# Create a new DSPy project
|
|
100
|
-
./.agent/scripts/dspy-helper.sh init my-chatbot
|
|
101
|
-
|
|
102
|
-
# Navigate to project directory
|
|
103
|
-
cd data/dspy/my-chatbot
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
### **Basic DSPy Example**
|
|
107
|
-
|
|
108
|
-
```python
|
|
109
|
-
import dspy
|
|
110
|
-
import os
|
|
111
|
-
|
|
112
|
-
# Configure DSPy with OpenAI
|
|
113
|
-
lm = dspy.OpenAI(model="gpt-3.5-turbo", api_key=os.getenv("OPENAI_API_KEY"))
|
|
114
|
-
dspy.settings.configure(lm=lm)
|
|
115
|
-
|
|
116
|
-
# Define a signature
|
|
117
|
-
class BasicQA(dspy.Signature):
|
|
118
|
-
"""Answer questions with helpful, accurate responses."""
|
|
119
|
-
question = dspy.InputField()
|
|
120
|
-
answer = dspy.OutputField(desc="A helpful and accurate answer")
|
|
121
|
-
|
|
122
|
-
# Create a module
|
|
123
|
-
class QAModule(dspy.Module):
|
|
124
|
-
def **init**(self):
|
|
125
|
-
super().**init**()
|
|
126
|
-
self.generate_answer = dspy.ChainOfThought(BasicQA)
|
|
127
|
-
|
|
128
|
-
def forward(self, question):
|
|
129
|
-
return self.generate_answer(question=question)
|
|
130
|
-
|
|
131
|
-
# Use the module
|
|
132
|
-
qa = QAModule()
|
|
133
|
-
result = qa(question="What is DSPy?")
|
|
134
|
-
print(result.answer)
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
### **Optimization Example**
|
|
138
|
-
|
|
139
|
-
```python
|
|
140
|
-
import dspy
|
|
141
|
-
from dspy.teleprompt import BootstrapFewShot
|
|
142
|
-
|
|
143
|
-
# Define training data
|
|
144
|
-
trainset = [
|
|
145
|
-
dspy.Example(question="What is AI?", answer="Artificial Intelligence..."),
|
|
146
|
-
dspy.Example(question="How does ML work?", answer="Machine Learning..."),
|
|
147
|
-
# Add more examples
|
|
148
|
-
]
|
|
149
|
-
|
|
150
|
-
# Create and compile optimizer
|
|
151
|
-
teleprompter = BootstrapFewShot(metric=dspy.evaluate.answer_exact_match)
|
|
152
|
-
compiled_qa = teleprompter.compile(QAModule(), trainset=trainset)
|
|
153
|
-
|
|
154
|
-
# Use optimized module
|
|
155
|
-
result = compiled_qa(question="Explain neural networks")
|
|
156
|
-
```
|
|
157
|
-
|
|
158
|
-
## 🔧 **Configuration Options**
|
|
159
|
-
|
|
160
|
-
### **Language Models**
|
|
161
|
-
|
|
162
|
-
```json
|
|
163
|
-
{
|
|
164
|
-
"language_models": {
|
|
165
|
-
"providers": {
|
|
166
|
-
"openai": {
|
|
167
|
-
"api_key": "YOUR_OPENAI_API_KEY",
|
|
168
|
-
"models": {
|
|
169
|
-
"gpt-4": "gpt-4",
|
|
170
|
-
"gpt-3.5-turbo": "gpt-3.5-turbo"
|
|
171
|
-
}
|
|
172
|
-
},
|
|
173
|
-
"anthropic": {
|
|
174
|
-
"api_key": "YOUR_ANTHROPIC_API_KEY",
|
|
175
|
-
"models": {
|
|
176
|
-
"claude-3-sonnet": "claude-3-sonnet-20240229"
|
|
177
|
-
}
|
|
178
|
-
}
|
|
179
|
-
}
|
|
180
|
-
}
|
|
181
|
-
}
|
|
182
|
-
```
|
|
183
|
-
|
|
184
|
-
### **Optimization Settings**
|
|
185
|
-
|
|
186
|
-
```json
|
|
187
|
-
{
|
|
188
|
-
"optimization": {
|
|
189
|
-
"optimizers": {
|
|
190
|
-
"BootstrapFewShot": {
|
|
191
|
-
"max_bootstrapped_demos": 4,
|
|
192
|
-
"max_labeled_demos": 16
|
|
193
|
-
},
|
|
194
|
-
"COPRO": {
|
|
195
|
-
"metric": "accuracy",
|
|
196
|
-
"breadth": 10,
|
|
197
|
-
"depth": 3
|
|
198
|
-
}
|
|
199
|
-
}
|
|
200
|
-
}
|
|
201
|
-
}
|
|
202
|
-
```
|
|
203
|
-
|
|
204
|
-
## 📊 **Available Optimizers**
|
|
205
|
-
|
|
206
|
-
### **BootstrapFewShot**
|
|
207
|
-
|
|
208
|
-
- **Purpose**: Automatically generate few-shot examples
|
|
209
|
-
- **Best for**: General prompt optimization
|
|
210
|
-
- **Configuration**: `max_bootstrapped_demos`, `max_labeled_demos`
|
|
211
|
-
|
|
212
|
-
### **COPRO (Coordinate Ascent)**
|
|
213
|
-
|
|
214
|
-
- **Purpose**: Iterative prompt optimization
|
|
215
|
-
- **Best for**: Complex reasoning tasks
|
|
216
|
-
- **Configuration**: `metric`, `breadth`, `depth`
|
|
217
|
-
|
|
218
|
-
### **MIPRO (Multi-Prompt Optimization)**
|
|
219
|
-
|
|
220
|
-
- **Purpose**: Multi-stage prompt optimization
|
|
221
|
-
- **Best for**: Multi-step reasoning
|
|
222
|
-
- **Configuration**: `metric`, `num_candidates`
|
|
223
|
-
|
|
224
|
-
## 🎯 **Best Practices**
|
|
225
|
-
|
|
226
|
-
### **1. Start Simple**
|
|
227
|
-
|
|
228
|
-
```python
|
|
229
|
-
# Begin with basic signatures
|
|
230
|
-
class SimpleQA(dspy.Signature):
|
|
231
|
-
question = dspy.InputField()
|
|
232
|
-
answer = dspy.OutputField()
|
|
233
|
-
```
|
|
234
|
-
|
|
235
|
-
### **2. Use Quality Training Data**
|
|
236
|
-
|
|
237
|
-
```python
|
|
238
|
-
# Provide diverse, high-quality examples
|
|
239
|
-
trainset = [
|
|
240
|
-
dspy.Example(question="...", answer="...").with_inputs('question'),
|
|
241
|
-
# More examples with clear input/output patterns
|
|
242
|
-
]
|
|
243
|
-
```
|
|
244
|
-
|
|
245
|
-
### **3. Choose Appropriate Metrics**
|
|
246
|
-
|
|
247
|
-
```python
|
|
248
|
-
# Define custom metrics for your use case
|
|
249
|
-
def custom_metric(example, pred, trace=None):
|
|
250
|
-
return example.answer.lower() in pred.answer.lower()
|
|
251
|
-
```
|
|
252
|
-
|
|
253
|
-
### **4. Iterate and Refine**
|
|
254
|
-
|
|
255
|
-
```python
|
|
256
|
-
# Test different optimizers and configurations
|
|
257
|
-
optimizers = [
|
|
258
|
-
BootstrapFewShot(metric=custom_metric),
|
|
259
|
-
COPRO(metric=custom_metric, breadth=5),
|
|
260
|
-
]
|
|
261
|
-
```
|
|
262
|
-
|
|
263
|
-
## 🔍 **Troubleshooting**
|
|
264
|
-
|
|
265
|
-
### **Common Issues**
|
|
266
|
-
|
|
267
|
-
1. **Import Errors**
|
|
268
|
-
|
|
269
|
-
```bash
|
|
270
|
-
# Ensure virtual environment is activated
|
|
271
|
-
source python-env/dspy-env/bin/activate
|
|
272
|
-
```
|
|
273
|
-
|
|
274
|
-
2. **API Key Issues**
|
|
275
|
-
|
|
276
|
-
```bash
|
|
277
|
-
# Check environment variables
|
|
278
|
-
echo $OPENAI_API_KEY
|
|
279
|
-
```
|
|
280
|
-
|
|
281
|
-
3. **Memory Issues**
|
|
282
|
-
|
|
283
|
-
```python
|
|
284
|
-
# Reduce batch sizes for large datasets
|
|
285
|
-
dspy.settings.configure(lm=lm, max_tokens=1000)
|
|
286
|
-
```
|
|
287
|
-
|
|
288
|
-
## 📚 **Additional Resources**
|
|
289
|
-
|
|
290
|
-
- [DSPy Documentation](https://dspy-docs.vercel.app/)
|
|
291
|
-
- [DSPy GitHub Repository](https://github.com/stanfordnlp/dspy)
|
|
292
|
-
- [DSPy Paper](https://arxiv.org/abs/2310.03714)
|
|
293
|
-
- [AI DevOps Framework Documentation](../README.md)
|
|
294
|
-
|
|
295
|
-
## 🤝 **Integration with AI DevOps**
|
|
296
|
-
|
|
297
|
-
DSPy integrates seamlessly with other AI DevOps Framework components:
|
|
298
|
-
|
|
299
|
-
- **Agno Integration**: Use DSPy-optimized prompts in Agno agents
|
|
300
|
-
- **Quality Control**: Optimize prompts for better code quality analysis
|
|
301
|
-
- **Documentation**: Generate optimized prompts for documentation tasks
|
|
302
|
-
- **Server Management**: Create optimized prompts for infrastructure tasks
|