@vodailoc/kilo-kit-mcp 1.1.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (582) hide show
  1. package/.mcp/kilo-kit.codex-windows.toml +5 -0
  2. package/LICENSE +190 -190
  3. package/QUICKSTART.md +265 -255
  4. package/README.md +321 -267
  5. package/mcp/README.md +64 -12
  6. package/mcp/dist/formatters.js +142 -1
  7. package/mcp/dist/orchestration-audit.js +20 -0
  8. package/mcp/dist/orchestration-memory.js +258 -0
  9. package/mcp/dist/orchestration-types.js +1 -0
  10. package/mcp/dist/orchestrator.js +222 -0
  11. package/mcp/dist/question-templates.js +249 -0
  12. package/mcp/dist/route-analytics.js +149 -0
  13. package/mcp/dist/router.js +75 -82
  14. package/mcp/dist/routing-policy-data.js +241 -0
  15. package/mcp/dist/routing-policy.js +145 -0
  16. package/mcp/dist/server.js +93 -4
  17. package/mcp/dist/smoke-env.js +18 -0
  18. package/mcp/dist/smoke.js +68 -1
  19. package/mcp/package.json +1 -2
  20. package/package.json +3 -2
  21. package/skills/README.md +647 -647
  22. package/skills/SKILLS_INDEX.md +139 -139
  23. package/skills/ai-media/ai-multimodal/.env.example +97 -97
  24. package/skills/ai-media/ai-multimodal/SKILL.md +357 -357
  25. package/skills/ai-media/ai-multimodal/references/audio-processing.md +373 -373
  26. package/skills/ai-media/ai-multimodal/references/image-generation.md +558 -558
  27. package/skills/ai-media/ai-multimodal/references/video-analysis.md +502 -502
  28. package/skills/ai-media/ai-multimodal/references/vision-understanding.md +483 -483
  29. package/skills/ai-media/ai-multimodal/scripts/document_converter.py +395 -395
  30. package/skills/ai-media/ai-multimodal/scripts/gemini_batch_process.py +480 -480
  31. package/skills/ai-media/ai-multimodal/scripts/media_optimizer.py +506 -506
  32. package/skills/ai-media/ai-multimodal/scripts/requirements.txt +26 -26
  33. package/skills/ai-media/ai-multimodal/scripts/tests/requirements.txt +20 -20
  34. package/skills/ai-media/ai-multimodal/scripts/tests/test_document_converter.py +299 -299
  35. package/skills/ai-media/ai-multimodal/scripts/tests/test_gemini_batch_process.py +362 -362
  36. package/skills/ai-media/ai-multimodal/scripts/tests/test_media_optimizer.py +373 -373
  37. package/skills/ai-media/media-processing/SKILL.md +358 -358
  38. package/skills/ai-media/media-processing/references/ffmpeg-encoding.md +358 -358
  39. package/skills/ai-media/media-processing/references/ffmpeg-filters.md +503 -503
  40. package/skills/ai-media/media-processing/references/ffmpeg-streaming.md +403 -403
  41. package/skills/ai-media/media-processing/references/format-compatibility.md +375 -375
  42. package/skills/ai-media/media-processing/references/imagemagick-batch.md +612 -612
  43. package/skills/ai-media/media-processing/references/imagemagick-editing.md +623 -623
  44. package/skills/ai-media/media-processing/scripts/batch_resize.py +342 -342
  45. package/skills/ai-media/media-processing/scripts/media_convert.py +311 -311
  46. package/skills/ai-media/media-processing/scripts/requirements.txt +24 -24
  47. package/skills/ai-media/media-processing/scripts/tests/requirements.txt +2 -2
  48. package/skills/ai-media/media-processing/scripts/tests/test_batch_resize.py +372 -372
  49. package/skills/ai-media/media-processing/scripts/tests/test_media_convert.py +259 -259
  50. package/skills/ai-media/media-processing/scripts/tests/test_video_optimize.py +397 -397
  51. package/skills/ai-media/media-processing/scripts/video_optimize.py +414 -414
  52. package/skills/ai-media/screenshot/LICENSE.txt +201 -201
  53. package/skills/ai-media/screenshot/SKILL.md +267 -267
  54. package/skills/ai-media/screenshot/agents/openai.yaml +6 -6
  55. package/skills/ai-media/screenshot/assets/screenshot-small.svg +5 -5
  56. package/skills/ai-media/screenshot/scripts/ensure_macos_permissions.sh +54 -54
  57. package/skills/ai-media/screenshot/scripts/macos_display_info.swift +22 -22
  58. package/skills/ai-media/screenshot/scripts/macos_permissions.swift +40 -40
  59. package/skills/ai-media/screenshot/scripts/macos_window_info.swift +126 -126
  60. package/skills/ai-media/screenshot/scripts/take_screenshot.ps1 +163 -163
  61. package/skills/ai-media/screenshot/scripts/take_screenshot.py +585 -585
  62. package/skills/ai-media/sora/LICENSE.txt +201 -201
  63. package/skills/ai-media/sora/SKILL.md +153 -153
  64. package/skills/ai-media/sora/agents/openai.yaml +6 -6
  65. package/skills/ai-media/sora/assets/sora-small.svg +4 -4
  66. package/skills/ai-media/sora/references/cinematic-shots.md +53 -53
  67. package/skills/ai-media/sora/references/cli.md +248 -248
  68. package/skills/ai-media/sora/references/codex-network.md +28 -28
  69. package/skills/ai-media/sora/references/prompting.md +137 -137
  70. package/skills/ai-media/sora/references/sample-prompts.md +95 -95
  71. package/skills/ai-media/sora/references/social-ads.md +42 -42
  72. package/skills/ai-media/sora/references/troubleshooting.md +58 -58
  73. package/skills/ai-media/sora/references/video-api.md +45 -45
  74. package/skills/ai-media/sora/scripts/sora.py +970 -970
  75. package/skills/design/aesthetic/SKILL.md +121 -121
  76. package/skills/design/aesthetic/assets/design-guideline-template.md +163 -163
  77. package/skills/design/aesthetic/assets/design-story-template.md +135 -135
  78. package/skills/design/aesthetic/references/design-principles.md +62 -62
  79. package/skills/design/aesthetic/references/design-resources.md +75 -75
  80. package/skills/design/aesthetic/references/micro-interactions.md +53 -53
  81. package/skills/design/aesthetic/references/storytelling-design.md +50 -50
  82. package/skills/design/figma/LICENSE.txt +202 -202
  83. package/skills/design/figma/SKILL.md +42 -42
  84. package/skills/design/figma/agents/openai.yaml +14 -14
  85. package/skills/design/figma/assets/figma-small.svg +3 -3
  86. package/skills/design/figma/assets/icon.svg +28 -28
  87. package/skills/design/figma/references/figma-mcp-config.md +35 -35
  88. package/skills/design/figma/references/figma-tools-and-prompts.md +34 -34
  89. package/skills/design/figma-implement-design/LICENSE.txt +202 -202
  90. package/skills/design/figma-implement-design/SKILL.md +264 -264
  91. package/skills/design/figma-implement-design/agents/openai.yaml +14 -14
  92. package/skills/design/figma-implement-design/assets/figma-small.svg +3 -3
  93. package/skills/design/figma-implement-design/assets/icon.svg +28 -28
  94. package/skills/design/frontend-design/SKILL.md +41 -41
  95. package/skills/design/frontend-design/references/animejs.md +395 -395
  96. package/skills/design/ui-styling/LICENSE.txt +201 -201
  97. package/skills/design/ui-styling/SKILL.md +321 -321
  98. package/skills/design/ui-styling/canvas-fonts/ArsenalSC-OFL.txt +93 -93
  99. package/skills/design/ui-styling/canvas-fonts/BigShoulders-OFL.txt +93 -93
  100. package/skills/design/ui-styling/canvas-fonts/Boldonse-OFL.txt +93 -93
  101. package/skills/design/ui-styling/canvas-fonts/BricolageGrotesque-OFL.txt +93 -93
  102. package/skills/design/ui-styling/canvas-fonts/CrimsonPro-OFL.txt +93 -93
  103. package/skills/design/ui-styling/canvas-fonts/DMMono-OFL.txt +93 -93
  104. package/skills/design/ui-styling/canvas-fonts/EricaOne-OFL.txt +94 -94
  105. package/skills/design/ui-styling/canvas-fonts/GeistMono-OFL.txt +93 -93
  106. package/skills/design/ui-styling/canvas-fonts/Gloock-OFL.txt +93 -93
  107. package/skills/design/ui-styling/canvas-fonts/IBMPlexMono-OFL.txt +93 -93
  108. package/skills/design/ui-styling/canvas-fonts/InstrumentSans-OFL.txt +93 -93
  109. package/skills/design/ui-styling/canvas-fonts/Italiana-OFL.txt +93 -93
  110. package/skills/design/ui-styling/canvas-fonts/JetBrainsMono-OFL.txt +93 -93
  111. package/skills/design/ui-styling/canvas-fonts/Jura-OFL.txt +93 -93
  112. package/skills/design/ui-styling/canvas-fonts/LibreBaskerville-OFL.txt +93 -93
  113. package/skills/design/ui-styling/canvas-fonts/Lora-OFL.txt +93 -93
  114. package/skills/design/ui-styling/canvas-fonts/NationalPark-OFL.txt +93 -93
  115. package/skills/design/ui-styling/canvas-fonts/NothingYouCouldDo-OFL.txt +93 -93
  116. package/skills/design/ui-styling/canvas-fonts/Outfit-OFL.txt +93 -93
  117. package/skills/design/ui-styling/canvas-fonts/PixelifySans-OFL.txt +93 -93
  118. package/skills/design/ui-styling/canvas-fonts/PoiretOne-OFL.txt +93 -93
  119. package/skills/design/ui-styling/canvas-fonts/RedHatMono-OFL.txt +93 -93
  120. package/skills/design/ui-styling/canvas-fonts/Silkscreen-OFL.txt +93 -93
  121. package/skills/design/ui-styling/canvas-fonts/SmoochSans-OFL.txt +93 -93
  122. package/skills/design/ui-styling/canvas-fonts/Tektur-OFL.txt +93 -93
  123. package/skills/design/ui-styling/canvas-fonts/WorkSans-OFL.txt +93 -93
  124. package/skills/design/ui-styling/canvas-fonts/YoungSerif-OFL.txt +93 -93
  125. package/skills/design/ui-styling/references/canvas-design-system.md +320 -320
  126. package/skills/design/ui-styling/references/shadcn-accessibility.md +471 -471
  127. package/skills/design/ui-styling/references/shadcn-components.md +424 -424
  128. package/skills/design/ui-styling/references/shadcn-theming.md +373 -373
  129. package/skills/design/ui-styling/references/tailwind-customization.md +483 -483
  130. package/skills/design/ui-styling/references/tailwind-responsive.md +382 -382
  131. package/skills/design/ui-styling/references/tailwind-utilities.md +455 -455
  132. package/skills/design/ui-styling/scripts/requirements.txt +17 -17
  133. package/skills/design/ui-styling/scripts/shadcn_add.py +292 -292
  134. package/skills/design/ui-styling/scripts/tailwind_config_gen.py +456 -456
  135. package/skills/design/ui-styling/scripts/tests/requirements.txt +3 -3
  136. package/skills/design/ui-styling/scripts/tests/test_shadcn_add.py +266 -266
  137. package/skills/design/ui-styling/scripts/tests/test_tailwind_config_gen.py +336 -336
  138. package/skills/engineering/aspnet-core/LICENSE.txt +201 -201
  139. package/skills/engineering/aspnet-core/SKILL.md +61 -61
  140. package/skills/engineering/aspnet-core/agents/openai.yaml +5 -5
  141. package/skills/engineering/aspnet-core/references/_sections.md +40 -40
  142. package/skills/engineering/aspnet-core/references/apis-minimal-and-controllers.md +81 -81
  143. package/skills/engineering/aspnet-core/references/data-state-and-services.md +69 -69
  144. package/skills/engineering/aspnet-core/references/program-and-pipeline.md +103 -103
  145. package/skills/engineering/aspnet-core/references/realtime-grpc-and-background-work.md +58 -58
  146. package/skills/engineering/aspnet-core/references/security-and-identity.md +75 -75
  147. package/skills/engineering/aspnet-core/references/source-map.md +43 -43
  148. package/skills/engineering/aspnet-core/references/stack-selection.md +63 -63
  149. package/skills/engineering/aspnet-core/references/testing-performance-and-operations.md +92 -92
  150. package/skills/engineering/aspnet-core/references/ui-blazor.md +53 -53
  151. package/skills/engineering/aspnet-core/references/ui-mvc.md +56 -56
  152. package/skills/engineering/aspnet-core/references/ui-razor-pages.md +55 -55
  153. package/skills/engineering/aspnet-core/references/versioning-and-upgrades.md +51 -51
  154. package/skills/engineering/backend-development/SKILL.md +95 -95
  155. package/skills/engineering/backend-development/references/backend-api-design.md +495 -495
  156. package/skills/engineering/backend-development/references/backend-architecture.md +454 -454
  157. package/skills/engineering/backend-development/references/backend-authentication.md +338 -338
  158. package/skills/engineering/backend-development/references/backend-code-quality.md +659 -659
  159. package/skills/engineering/backend-development/references/backend-debugging.md +904 -904
  160. package/skills/engineering/backend-development/references/backend-devops.md +494 -494
  161. package/skills/engineering/backend-development/references/backend-mindset.md +387 -387
  162. package/skills/engineering/backend-development/references/backend-performance.md +397 -397
  163. package/skills/engineering/backend-development/references/backend-security.md +290 -290
  164. package/skills/engineering/backend-development/references/backend-technologies.md +256 -256
  165. package/skills/engineering/backend-development/references/backend-testing.md +429 -429
  166. package/skills/engineering/better-auth/SKILL.md +204 -204
  167. package/skills/engineering/better-auth/references/advanced-features.md +553 -553
  168. package/skills/engineering/better-auth/references/database-integration.md +577 -577
  169. package/skills/engineering/better-auth/references/email-password-auth.md +416 -416
  170. package/skills/engineering/better-auth/references/oauth-providers.md +430 -430
  171. package/skills/engineering/better-auth/scripts/better_auth_init.py +521 -521
  172. package/skills/engineering/better-auth/scripts/requirements.txt +15 -15
  173. package/skills/engineering/better-auth/scripts/tests/test_better_auth_init.py +421 -421
  174. package/skills/engineering/code-review/SKILL.md +140 -140
  175. package/skills/engineering/code-review/references/code-review-reception.md +208 -208
  176. package/skills/engineering/code-review/references/requesting-code-review.md +104 -104
  177. package/skills/engineering/code-review/references/verification-before-completion.md +138 -138
  178. package/skills/engineering/context-engineering/SKILL.md +86 -86
  179. package/skills/engineering/context-engineering/references/context-compression.md +84 -84
  180. package/skills/engineering/context-engineering/references/context-degradation.md +93 -93
  181. package/skills/engineering/context-engineering/references/context-fundamentals.md +75 -75
  182. package/skills/engineering/context-engineering/references/context-optimization.md +82 -82
  183. package/skills/engineering/context-engineering/references/evaluation.md +89 -89
  184. package/skills/engineering/context-engineering/references/memory-systems.md +88 -88
  185. package/skills/engineering/context-engineering/references/multi-agent-patterns.md +90 -90
  186. package/skills/engineering/context-engineering/references/project-development.md +97 -97
  187. package/skills/engineering/context-engineering/references/tool-design.md +86 -86
  188. package/skills/engineering/context-engineering/scripts/compression_evaluator.py +329 -329
  189. package/skills/engineering/context-engineering/scripts/context_analyzer.py +294 -294
  190. package/skills/engineering/databases/SKILL.md +232 -232
  191. package/skills/engineering/databases/references/mongodb-aggregation.md +447 -447
  192. package/skills/engineering/databases/references/mongodb-atlas.md +465 -465
  193. package/skills/engineering/databases/references/mongodb-crud.md +408 -408
  194. package/skills/engineering/databases/references/mongodb-indexing.md +442 -442
  195. package/skills/engineering/databases/references/postgresql-administration.md +594 -594
  196. package/skills/engineering/databases/references/postgresql-performance.md +527 -527
  197. package/skills/engineering/databases/references/postgresql-psql-cli.md +467 -467
  198. package/skills/engineering/databases/references/postgresql-queries.md +475 -475
  199. package/skills/engineering/databases/scripts/db_backup.py +502 -502
  200. package/skills/engineering/databases/scripts/db_migrate.py +414 -414
  201. package/skills/engineering/databases/scripts/db_performance_check.py +444 -444
  202. package/skills/engineering/databases/scripts/requirements.txt +20 -20
  203. package/skills/engineering/databases/scripts/tests/requirements.txt +4 -4
  204. package/skills/engineering/databases/scripts/tests/test_db_backup.py +340 -340
  205. package/skills/engineering/databases/scripts/tests/test_db_migrate.py +277 -277
  206. package/skills/engineering/databases/scripts/tests/test_db_performance_check.py +370 -370
  207. package/skills/engineering/diagnose/SKILL.md +117 -117
  208. package/skills/engineering/diagnose/scripts/hitl-loop.template.sh +41 -41
  209. package/skills/engineering/docs-seeker/SKILL.md +207 -207
  210. package/skills/engineering/docs-seeker/WORKFLOWS.md +505 -505
  211. package/skills/engineering/docs-seeker/references/best-practices.md +632 -632
  212. package/skills/engineering/docs-seeker/references/documentation-sources.md +461 -461
  213. package/skills/engineering/docs-seeker/references/error-handling.md +621 -621
  214. package/skills/engineering/docs-seeker/references/limitations.md +821 -821
  215. package/skills/engineering/docs-seeker/references/performance.md +574 -574
  216. package/skills/engineering/docs-seeker/references/tool-selection.md +262 -262
  217. package/skills/engineering/frontend-development/SKILL.md +398 -398
  218. package/skills/engineering/frontend-development/resources/common-patterns.md +330 -330
  219. package/skills/engineering/frontend-development/resources/complete-examples.md +871 -871
  220. package/skills/engineering/frontend-development/resources/component-patterns.md +501 -501
  221. package/skills/engineering/frontend-development/resources/data-fetching.md +766 -766
  222. package/skills/engineering/frontend-development/resources/file-organization.md +501 -501
  223. package/skills/engineering/frontend-development/resources/loading-and-error-states.md +500 -500
  224. package/skills/engineering/frontend-development/resources/performance.md +405 -405
  225. package/skills/engineering/frontend-development/resources/routing-guide.md +363 -363
  226. package/skills/engineering/frontend-development/resources/styling-guide.md +427 -427
  227. package/skills/engineering/frontend-development/resources/typescript-standards.md +417 -417
  228. package/skills/engineering/improve-codebase-architecture/DEEPENING.md +37 -37
  229. package/skills/engineering/improve-codebase-architecture/INTERFACE-DESIGN.md +44 -44
  230. package/skills/engineering/improve-codebase-architecture/LANGUAGE.md +53 -53
  231. package/skills/engineering/improve-codebase-architecture/SKILL.md +71 -71
  232. package/skills/engineering/openai-docs/LICENSE.txt +201 -201
  233. package/skills/engineering/openai-docs/SKILL.md +69 -69
  234. package/skills/engineering/openai-docs/agents/openai.yaml +14 -14
  235. package/skills/engineering/openai-docs/assets/openai-small.svg +3 -3
  236. package/skills/engineering/openai-docs/references/gpt-5p4-prompting-guide.md +433 -433
  237. package/skills/engineering/openai-docs/references/latest-model.md +35 -35
  238. package/skills/engineering/openai-docs/references/upgrading-to-gpt-5p4.md +164 -164
  239. package/skills/engineering/playwright/LICENSE.txt +201 -201
  240. package/skills/engineering/playwright/NOTICE.txt +14 -14
  241. package/skills/engineering/playwright/SKILL.md +147 -147
  242. package/skills/engineering/playwright/agents/openai.yaml +6 -6
  243. package/skills/engineering/playwright/assets/playwright-small.svg +3 -3
  244. package/skills/engineering/playwright/references/cli.md +116 -116
  245. package/skills/engineering/playwright/references/workflows.md +95 -95
  246. package/skills/engineering/playwright/scripts/playwright_cli.sh +25 -25
  247. package/skills/engineering/playwright-interactive/LICENSE.txt +201 -201
  248. package/skills/engineering/playwright-interactive/NOTICE.txt +13 -13
  249. package/skills/engineering/playwright-interactive/SKILL.md +689 -689
  250. package/skills/engineering/playwright-interactive/agents/openai.yaml +6 -6
  251. package/skills/engineering/playwright-interactive/assets/playwright-small.svg +3 -3
  252. package/skills/engineering/render-deploy/LICENSE.txt +201 -201
  253. package/skills/engineering/render-deploy/SKILL.md +479 -479
  254. package/skills/engineering/render-deploy/agents/openai.yaml +14 -14
  255. package/skills/engineering/render-deploy/assets/docker.yaml +62 -62
  256. package/skills/engineering/render-deploy/assets/go-api.yaml +35 -35
  257. package/skills/engineering/render-deploy/assets/nextjs-postgres.yaml +35 -35
  258. package/skills/engineering/render-deploy/assets/node-express.yaml +25 -25
  259. package/skills/engineering/render-deploy/assets/python-django.yaml +89 -89
  260. package/skills/engineering/render-deploy/assets/render-small.svg +3 -3
  261. package/skills/engineering/render-deploy/assets/static-site.yaml +54 -54
  262. package/skills/engineering/render-deploy/references/blueprint-spec.md +718 -718
  263. package/skills/engineering/render-deploy/references/codebase-analysis.md +49 -49
  264. package/skills/engineering/render-deploy/references/configuration-guide.md +603 -603
  265. package/skills/engineering/render-deploy/references/deployment-details.md +224 -224
  266. package/skills/engineering/render-deploy/references/direct-creation.md +113 -113
  267. package/skills/engineering/render-deploy/references/error-patterns.md +13 -13
  268. package/skills/engineering/render-deploy/references/post-deploy-checks.md +36 -36
  269. package/skills/engineering/render-deploy/references/runtimes.md +473 -473
  270. package/skills/engineering/render-deploy/references/service-types.md +450 -450
  271. package/skills/engineering/render-deploy/references/troubleshooting-basics.md +36 -36
  272. package/skills/engineering/repomix/SKILL.md +215 -215
  273. package/skills/engineering/repomix/references/configuration.md +211 -211
  274. package/skills/engineering/repomix/references/usage-patterns.md +232 -232
  275. package/skills/engineering/repomix/scripts/README.md +179 -179
  276. package/skills/engineering/repomix/scripts/repomix_batch.py +455 -455
  277. package/skills/engineering/repomix/scripts/repos.example.json +15 -15
  278. package/skills/engineering/repomix/scripts/requirements.txt +15 -15
  279. package/skills/engineering/repomix/scripts/tests/test_repomix_batch.py +531 -531
  280. package/skills/engineering/setup-matt-pocock-skills/SKILL.md +121 -121
  281. package/skills/engineering/setup-matt-pocock-skills/domain.md +51 -51
  282. package/skills/engineering/setup-matt-pocock-skills/issue-tracker-github.md +22 -22
  283. package/skills/engineering/setup-matt-pocock-skills/issue-tracker-gitlab.md +23 -23
  284. package/skills/engineering/setup-matt-pocock-skills/issue-tracker-local.md +19 -19
  285. package/skills/engineering/setup-matt-pocock-skills/triage-labels.md +15 -15
  286. package/skills/engineering/shopify/README.md +66 -66
  287. package/skills/engineering/shopify/SKILL.md +319 -319
  288. package/skills/engineering/shopify/references/app-development.md +470 -470
  289. package/skills/engineering/shopify/references/extensions.md +493 -493
  290. package/skills/engineering/shopify/references/themes.md +498 -498
  291. package/skills/engineering/shopify/scripts/requirements.txt +19 -19
  292. package/skills/engineering/shopify/scripts/shopify_init.py +423 -423
  293. package/skills/engineering/shopify/scripts/tests/test_shopify_init.py +385 -385
  294. package/skills/engineering/tdd/SKILL.md +109 -109
  295. package/skills/engineering/tdd/deep-modules.md +33 -33
  296. package/skills/engineering/tdd/interface-design.md +31 -31
  297. package/skills/engineering/tdd/mocking.md +59 -59
  298. package/skills/engineering/tdd/refactoring.md +10 -10
  299. package/skills/engineering/tdd/tests.md +61 -61
  300. package/skills/engineering/to-issues/SKILL.md +81 -81
  301. package/skills/engineering/to-prd/SKILL.md +74 -74
  302. package/skills/engineering/triage/AGENT-BRIEF.md +168 -168
  303. package/skills/engineering/triage/OUT-OF-SCOPE.md +101 -101
  304. package/skills/engineering/triage/SKILL.md +103 -103
  305. package/skills/engineering/web-frameworks/SKILL.md +324 -324
  306. package/skills/engineering/web-frameworks/references/nextjs-app-router.md +465 -465
  307. package/skills/engineering/web-frameworks/references/nextjs-data-fetching.md +459 -459
  308. package/skills/engineering/web-frameworks/references/nextjs-optimization.md +511 -511
  309. package/skills/engineering/web-frameworks/references/nextjs-server-components.md +495 -495
  310. package/skills/engineering/web-frameworks/references/remix-icon-integration.md +603 -603
  311. package/skills/engineering/web-frameworks/references/turborepo-caching.md +551 -551
  312. package/skills/engineering/web-frameworks/references/turborepo-pipelines.md +517 -517
  313. package/skills/engineering/web-frameworks/references/turborepo-setup.md +542 -542
  314. package/skills/engineering/web-frameworks/scripts/nextjs_init.py +547 -547
  315. package/skills/engineering/web-frameworks/scripts/requirements.txt +16 -16
  316. package/skills/engineering/web-frameworks/scripts/tests/requirements.txt +3 -3
  317. package/skills/engineering/web-frameworks/scripts/tests/test_nextjs_init.py +319 -319
  318. package/skills/engineering/web-frameworks/scripts/tests/test_turborepo_migrate.py +374 -374
  319. package/skills/engineering/web-frameworks/scripts/turborepo_migrate.py +394 -394
  320. package/skills/engineering/write-a-skill/SKILL.md +117 -117
  321. package/skills/kilo-kit/SKILL.md +346 -346
  322. package/skills/kilo-kit/_template/SKILL.md +185 -185
  323. package/skills/kilo-kit/debugging/root-cause/SKILL.md +360 -360
  324. package/skills/kilo-kit/debugging/systematic/SKILL.md +339 -339
  325. package/skills/kilo-kit/debugging/verification/SKILL.md +424 -424
  326. package/skills/kilo-kit/development/backend/SKILL.md +540 -540
  327. package/skills/kilo-kit/development/security/SKILL.md +529 -529
  328. package/skills/kilo-kit/quality/code-review/SKILL.md +297 -297
  329. package/skills/kilo-kit/quality/testing/SKILL.md +540 -540
  330. package/skills/kilo-kit/references/output-formats.md +204 -204
  331. package/skills/kilo-kit/references/patterns.md +156 -156
  332. package/skills/kilo-kit/references/performance-benchmarks.md +90 -90
  333. package/skills/operations/chrome-devtools/SKILL.md +392 -392
  334. package/skills/operations/chrome-devtools/references/cdp-domains.md +694 -694
  335. package/skills/operations/chrome-devtools/references/performance-guide.md +940 -940
  336. package/skills/operations/chrome-devtools/references/puppeteer-reference.md +953 -953
  337. package/skills/operations/chrome-devtools/scripts/PERSISTENT-BROWSER.md +107 -107
  338. package/skills/operations/chrome-devtools/scripts/README.md +213 -213
  339. package/skills/operations/chrome-devtools/scripts/__tests__/selector.test.js +210 -210
  340. package/skills/operations/chrome-devtools/scripts/click.js +79 -79
  341. package/skills/operations/chrome-devtools/scripts/close-persistent.js +36 -36
  342. package/skills/operations/chrome-devtools/scripts/console.js +75 -75
  343. package/skills/operations/chrome-devtools/scripts/evaluate.js +49 -49
  344. package/skills/operations/chrome-devtools/scripts/fill.js +72 -72
  345. package/skills/operations/chrome-devtools/scripts/install-deps.sh +181 -181
  346. package/skills/operations/chrome-devtools/scripts/install.sh +83 -83
  347. package/skills/operations/chrome-devtools/scripts/launch-persistent.js +71 -71
  348. package/skills/operations/chrome-devtools/scripts/lib/browser.js +144 -144
  349. package/skills/operations/chrome-devtools/scripts/lib/selector.js +178 -178
  350. package/skills/operations/chrome-devtools/scripts/navigate.js +46 -46
  351. package/skills/operations/chrome-devtools/scripts/network.js +102 -102
  352. package/skills/operations/chrome-devtools/scripts/package-lock.json +1206 -1206
  353. package/skills/operations/chrome-devtools/scripts/package.json +15 -15
  354. package/skills/operations/chrome-devtools/scripts/performance.js +145 -145
  355. package/skills/operations/chrome-devtools/scripts/screenshot.js +180 -180
  356. package/skills/operations/chrome-devtools/scripts/snapshot.js +131 -131
  357. package/skills/operations/devops/.env.example +76 -76
  358. package/skills/operations/devops/SKILL.md +285 -285
  359. package/skills/operations/devops/references/browser-rendering.md +305 -305
  360. package/skills/operations/devops/references/cloudflare-d1-kv.md +123 -123
  361. package/skills/operations/devops/references/cloudflare-platform.md +271 -271
  362. package/skills/operations/devops/references/cloudflare-r2-storage.md +280 -280
  363. package/skills/operations/devops/references/cloudflare-workers-advanced.md +312 -312
  364. package/skills/operations/devops/references/cloudflare-workers-apis.md +309 -309
  365. package/skills/operations/devops/references/cloudflare-workers-basics.md +418 -418
  366. package/skills/operations/devops/references/docker-basics.md +297 -297
  367. package/skills/operations/devops/references/docker-compose.md +292 -292
  368. package/skills/operations/devops/references/gcloud-platform.md +297 -297
  369. package/skills/operations/devops/references/gcloud-services.md +304 -304
  370. package/skills/operations/devops/scripts/cloudflare_deploy.py +269 -269
  371. package/skills/operations/devops/scripts/docker_optimize.py +320 -320
  372. package/skills/operations/devops/scripts/requirements.txt +20 -20
  373. package/skills/operations/devops/scripts/tests/requirements.txt +3 -3
  374. package/skills/operations/devops/scripts/tests/test_cloudflare_deploy.py +285 -285
  375. package/skills/operations/devops/scripts/tests/test_docker_optimize.py +436 -436
  376. package/skills/operations/mcp-builder/LICENSE.txt +201 -201
  377. package/skills/operations/mcp-builder/SKILL.md +328 -328
  378. package/skills/operations/mcp-builder/reference/evaluation.md +601 -601
  379. package/skills/operations/mcp-builder/reference/mcp_best_practices.md +915 -915
  380. package/skills/operations/mcp-builder/reference/node_mcp_server.md +915 -915
  381. package/skills/operations/mcp-builder/reference/python_mcp_server.md +751 -751
  382. package/skills/operations/mcp-builder/scripts/connections.py +151 -151
  383. package/skills/operations/mcp-builder/scripts/evaluation.py +373 -373
  384. package/skills/operations/mcp-builder/scripts/example_evaluation.xml +22 -22
  385. package/skills/operations/mcp-builder/scripts/requirements.txt +2 -2
  386. package/skills/operations/mcp-management/README.md +219 -219
  387. package/skills/operations/mcp-management/SKILL.md +175 -175
  388. package/skills/operations/mcp-management/assets/tools.json +3043 -3043
  389. package/skills/operations/mcp-management/references/configuration.md +114 -114
  390. package/skills/operations/mcp-management/references/gemini-cli-integration.md +201 -201
  391. package/skills/operations/mcp-management/references/mcp-protocol.md +116 -116
  392. package/skills/operations/mcp-management/scripts/.env.example +10 -10
  393. package/skills/operations/mcp-management/scripts/cli.ts +155 -155
  394. package/skills/operations/mcp-management/scripts/dist/analyze-tools.js +70 -70
  395. package/skills/operations/mcp-management/scripts/dist/cli.js +131 -131
  396. package/skills/operations/mcp-management/scripts/dist/mcp-client.js +115 -115
  397. package/skills/operations/mcp-management/scripts/mcp-client.ts +163 -163
  398. package/skills/operations/mcp-management/scripts/package.json +18 -18
  399. package/skills/operations/mcp-management/scripts/tsconfig.json +15 -15
  400. package/skills/problem-solving/collision-zone-thinking/SKILL.md +62 -62
  401. package/skills/problem-solving/defense-in-depth/SKILL.md +130 -130
  402. package/skills/problem-solving/inversion-exercise/SKILL.md +58 -58
  403. package/skills/problem-solving/meta-pattern-recognition/SKILL.md +54 -54
  404. package/skills/problem-solving/root-cause-tracing/SKILL.md +177 -177
  405. package/skills/problem-solving/root-cause-tracing/find-polluter.sh +63 -63
  406. package/skills/problem-solving/scale-game/SKILL.md +63 -63
  407. package/skills/problem-solving/sequential-thinking/README.md +118 -118
  408. package/skills/problem-solving/sequential-thinking/SKILL.md +93 -93
  409. package/skills/problem-solving/sequential-thinking/references/advanced.md +122 -122
  410. package/skills/problem-solving/sequential-thinking/references/examples.md +274 -274
  411. package/skills/problem-solving/simplification-cascades/SKILL.md +76 -76
  412. package/skills/problem-solving/when-stuck/SKILL.md +88 -88
  413. package/skills/productivity/caveman/SKILL.md +49 -49
  414. package/skills/productivity/grill-me/SKILL.md +10 -10
  415. package/skills/productivity/grill-with-docs/ADR-FORMAT.md +47 -47
  416. package/skills/productivity/grill-with-docs/CONTEXT-FORMAT.md +77 -77
  417. package/skills/productivity/grill-with-docs/SKILL.md +88 -88
  418. package/skills/productivity/writing-skills/graphviz-conventions.dot +171 -171
  419. package/skills/productivity/zoom-out/SKILL.md +7 -7
  420. package/skills/writing-docs/doc/LICENSE.txt +201 -201
  421. package/skills/writing-docs/doc/SKILL.md +80 -80
  422. package/skills/writing-docs/doc/agents/openai.yaml +6 -6
  423. package/skills/writing-docs/doc/assets/doc-small.svg +3 -3
  424. package/skills/writing-docs/doc/scripts/render_docx.py +296 -296
  425. package/skills/writing-docs/docx/LICENSE.txt +30 -30
  426. package/skills/writing-docs/docx/SKILL.md +196 -196
  427. package/skills/writing-docs/docx/docx-js.md +349 -349
  428. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +1499 -1499
  429. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +146 -146
  430. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +1085 -1085
  431. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +11 -11
  432. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +3081 -3081
  433. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +23 -23
  434. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +185 -185
  435. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +287 -287
  436. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +1676 -1676
  437. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +28 -28
  438. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +144 -144
  439. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +174 -174
  440. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +25 -25
  441. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +18 -18
  442. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +59 -59
  443. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +56 -56
  444. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +195 -195
  445. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +582 -582
  446. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +25 -25
  447. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +4439 -4439
  448. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +570 -570
  449. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +509 -509
  450. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +12 -12
  451. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +108 -108
  452. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +96 -96
  453. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +3646 -3646
  454. package/skills/writing-docs/docx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +116 -116
  455. package/skills/writing-docs/docx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +42 -42
  456. package/skills/writing-docs/docx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +50 -50
  457. package/skills/writing-docs/docx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +49 -49
  458. package/skills/writing-docs/docx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +33 -33
  459. package/skills/writing-docs/docx/ooxml/schemas/mce/mc.xsd +75 -75
  460. package/skills/writing-docs/docx/ooxml/schemas/microsoft/wml-2010.xsd +560 -560
  461. package/skills/writing-docs/docx/ooxml/schemas/microsoft/wml-2012.xsd +67 -67
  462. package/skills/writing-docs/docx/ooxml/schemas/microsoft/wml-2018.xsd +14 -14
  463. package/skills/writing-docs/docx/ooxml/schemas/microsoft/wml-cex-2018.xsd +20 -20
  464. package/skills/writing-docs/docx/ooxml/schemas/microsoft/wml-cid-2016.xsd +13 -13
  465. package/skills/writing-docs/docx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +4 -4
  466. package/skills/writing-docs/docx/ooxml/schemas/microsoft/wml-symex-2015.xsd +8 -8
  467. package/skills/writing-docs/docx/ooxml/scripts/pack.py +159 -159
  468. package/skills/writing-docs/docx/ooxml/scripts/unpack.py +29 -29
  469. package/skills/writing-docs/docx/ooxml/scripts/validate.py +69 -69
  470. package/skills/writing-docs/docx/ooxml/scripts/validation/__init__.py +15 -15
  471. package/skills/writing-docs/docx/ooxml/scripts/validation/base.py +951 -951
  472. package/skills/writing-docs/docx/ooxml/scripts/validation/docx.py +274 -274
  473. package/skills/writing-docs/docx/ooxml/scripts/validation/pptx.py +315 -315
  474. package/skills/writing-docs/docx/ooxml/scripts/validation/redlining.py +279 -279
  475. package/skills/writing-docs/docx/ooxml.md +609 -609
  476. package/skills/writing-docs/docx/scripts/__init__.py +1 -1
  477. package/skills/writing-docs/docx/scripts/document.py +1276 -1276
  478. package/skills/writing-docs/docx/scripts/templates/comments.xml +2 -2
  479. package/skills/writing-docs/docx/scripts/templates/commentsExtended.xml +2 -2
  480. package/skills/writing-docs/docx/scripts/templates/commentsExtensible.xml +2 -2
  481. package/skills/writing-docs/docx/scripts/templates/commentsIds.xml +2 -2
  482. package/skills/writing-docs/docx/scripts/templates/people.xml +2 -2
  483. package/skills/writing-docs/docx/scripts/utilities.py +374 -374
  484. package/skills/writing-docs/mermaidjs-v11/SKILL.md +115 -115
  485. package/skills/writing-docs/mermaidjs-v11/references/cli-usage.md +228 -228
  486. package/skills/writing-docs/mermaidjs-v11/references/configuration.md +232 -232
  487. package/skills/writing-docs/mermaidjs-v11/references/diagram-types.md +315 -315
  488. package/skills/writing-docs/mermaidjs-v11/references/examples.md +344 -344
  489. package/skills/writing-docs/mermaidjs-v11/references/integration.md +310 -310
  490. package/skills/writing-docs/pdf/LICENSE.txt +30 -30
  491. package/skills/writing-docs/pdf/SKILL.md +294 -294
  492. package/skills/writing-docs/pdf/forms.md +205 -205
  493. package/skills/writing-docs/pdf/reference.md +611 -611
  494. package/skills/writing-docs/pdf/scripts/check_bounding_boxes.py +70 -70
  495. package/skills/writing-docs/pdf/scripts/check_bounding_boxes_test.py +226 -226
  496. package/skills/writing-docs/pdf/scripts/check_fillable_fields.py +12 -12
  497. package/skills/writing-docs/pdf/scripts/convert_pdf_to_images.py +35 -35
  498. package/skills/writing-docs/pdf/scripts/create_validation_image.py +41 -41
  499. package/skills/writing-docs/pdf/scripts/extract_form_field_info.py +152 -152
  500. package/skills/writing-docs/pdf/scripts/fill_fillable_fields.py +114 -114
  501. package/skills/writing-docs/pdf/scripts/fill_pdf_form_with_annotations.py +107 -107
  502. package/skills/writing-docs/pptx/LICENSE.txt +30 -30
  503. package/skills/writing-docs/pptx/SKILL.md +483 -483
  504. package/skills/writing-docs/pptx/html2pptx.md +624 -624
  505. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chart.xsd +1499 -1499
  506. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-chartDrawing.xsd +146 -146
  507. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-diagram.xsd +1085 -1085
  508. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-lockedCanvas.xsd +11 -11
  509. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-main.xsd +3081 -3081
  510. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-picture.xsd +23 -23
  511. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-spreadsheetDrawing.xsd +185 -185
  512. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/dml-wordprocessingDrawing.xsd +287 -287
  513. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/pml.xsd +1676 -1676
  514. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-additionalCharacteristics.xsd +28 -28
  515. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-bibliography.xsd +144 -144
  516. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-commonSimpleTypes.xsd +174 -174
  517. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlDataProperties.xsd +25 -25
  518. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-customXmlSchemaProperties.xsd +18 -18
  519. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesCustom.xsd +59 -59
  520. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesExtended.xsd +56 -56
  521. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-documentPropertiesVariantTypes.xsd +195 -195
  522. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-math.xsd +582 -582
  523. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/shared-relationshipReference.xsd +25 -25
  524. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/sml.xsd +4439 -4439
  525. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-main.xsd +570 -570
  526. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-officeDrawing.xsd +509 -509
  527. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-presentationDrawing.xsd +12 -12
  528. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-spreadsheetDrawing.xsd +108 -108
  529. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/vml-wordprocessingDrawing.xsd +96 -96
  530. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/wml.xsd +3646 -3646
  531. package/skills/writing-docs/pptx/ooxml/schemas/ISO-IEC29500-4_2016/xml.xsd +116 -116
  532. package/skills/writing-docs/pptx/ooxml/schemas/ecma/fouth-edition/opc-contentTypes.xsd +42 -42
  533. package/skills/writing-docs/pptx/ooxml/schemas/ecma/fouth-edition/opc-coreProperties.xsd +50 -50
  534. package/skills/writing-docs/pptx/ooxml/schemas/ecma/fouth-edition/opc-digSig.xsd +49 -49
  535. package/skills/writing-docs/pptx/ooxml/schemas/ecma/fouth-edition/opc-relationships.xsd +33 -33
  536. package/skills/writing-docs/pptx/ooxml/schemas/mce/mc.xsd +75 -75
  537. package/skills/writing-docs/pptx/ooxml/schemas/microsoft/wml-2010.xsd +560 -560
  538. package/skills/writing-docs/pptx/ooxml/schemas/microsoft/wml-2012.xsd +67 -67
  539. package/skills/writing-docs/pptx/ooxml/schemas/microsoft/wml-2018.xsd +14 -14
  540. package/skills/writing-docs/pptx/ooxml/schemas/microsoft/wml-cex-2018.xsd +20 -20
  541. package/skills/writing-docs/pptx/ooxml/schemas/microsoft/wml-cid-2016.xsd +13 -13
  542. package/skills/writing-docs/pptx/ooxml/schemas/microsoft/wml-sdtdatahash-2020.xsd +4 -4
  543. package/skills/writing-docs/pptx/ooxml/schemas/microsoft/wml-symex-2015.xsd +8 -8
  544. package/skills/writing-docs/pptx/ooxml/scripts/pack.py +159 -159
  545. package/skills/writing-docs/pptx/ooxml/scripts/unpack.py +29 -29
  546. package/skills/writing-docs/pptx/ooxml/scripts/validate.py +69 -69
  547. package/skills/writing-docs/pptx/ooxml/scripts/validation/__init__.py +15 -15
  548. package/skills/writing-docs/pptx/ooxml/scripts/validation/base.py +951 -951
  549. package/skills/writing-docs/pptx/ooxml/scripts/validation/docx.py +274 -274
  550. package/skills/writing-docs/pptx/ooxml/scripts/validation/pptx.py +315 -315
  551. package/skills/writing-docs/pptx/ooxml/scripts/validation/redlining.py +279 -279
  552. package/skills/writing-docs/pptx/ooxml.md +426 -426
  553. package/skills/writing-docs/pptx/scripts/html2pptx.js +978 -978
  554. package/skills/writing-docs/pptx/scripts/inventory.py +1020 -1020
  555. package/skills/writing-docs/pptx/scripts/rearrange.py +231 -231
  556. package/skills/writing-docs/pptx/scripts/replace.py +385 -385
  557. package/skills/writing-docs/pptx/scripts/thumbnail.py +450 -450
  558. package/skills/writing-docs/slides/LICENSE.txt +201 -201
  559. package/skills/writing-docs/slides/SKILL.md +71 -71
  560. package/skills/writing-docs/slides/agents/openai.yaml +6 -6
  561. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/code.js +104 -104
  562. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/image.js +333 -333
  563. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/index.js +33 -33
  564. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/latex.js +51 -51
  565. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/layout.js +643 -643
  566. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/layout_builders.js +358 -358
  567. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/svg.js +36 -36
  568. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/text.js +789 -789
  569. package/skills/writing-docs/slides/assets/pptxgenjs_helpers/util.js +24 -24
  570. package/skills/writing-docs/slides/assets/slides-small.svg +3 -3
  571. package/skills/writing-docs/slides/references/pptxgenjs-helpers.md +61 -61
  572. package/skills/writing-docs/slides/scripts/create_montage.py +300 -300
  573. package/skills/writing-docs/slides/scripts/detect_font.py +873 -873
  574. package/skills/writing-docs/slides/scripts/ensure_raster_image.py +202 -202
  575. package/skills/writing-docs/slides/scripts/render_slides.py +273 -273
  576. package/skills/writing-docs/slides/scripts/slides_test.py +201 -201
  577. package/skills/writing-docs/template-skill/SKILL.md +26 -26
  578. package/skills/writing-docs/xlsx/LICENSE.txt +30 -30
  579. package/skills/writing-docs/xlsx/SKILL.md +288 -288
  580. package/skills/writing-docs/xlsx/recalc.py +177 -177
  581. package/src/core/KILO_MASTER.md +448 -448
  582. package/src/tools/validate-skill.js +421 -421
@@ -1,752 +1,752 @@
1
- # Python MCP Server Implementation Guide
2
-
3
- ## Overview
4
-
5
- This document provides Python-specific best practices and examples for implementing MCP servers using the MCP Python SDK. It covers server setup, tool registration patterns, input validation with Pydantic, error handling, and complete working examples.
6
-
7
- ---
8
-
9
- ## Quick Reference
10
-
11
- ### Key Imports
12
- ```python
13
- from mcp.server.fastmcp import FastMCP
14
- from pydantic import BaseModel, Field, field_validator, ConfigDict
15
- from typing import Optional, List, Dict, Any
16
- from enum import Enum
17
- import httpx
18
- ```
19
-
20
- ### Server Initialization
21
- ```python
22
- mcp = FastMCP("service_mcp")
23
- ```
24
-
25
- ### Tool Registration Pattern
26
- ```python
27
- @mcp.tool(name="tool_name", annotations={...})
28
- async def tool_function(params: InputModel) -> str:
29
- # Implementation
30
- pass
31
- ```
32
-
33
- ---
34
-
35
- ## MCP Python SDK and FastMCP
36
-
37
- The official MCP Python SDK provides FastMCP, a high-level framework for building MCP servers. It provides:
38
- - Automatic description and inputSchema generation from function signatures and docstrings
39
- - Pydantic model integration for input validation
40
- - Decorator-based tool registration with `@mcp.tool`
41
-
42
- **For complete SDK documentation, use WebFetch to load:**
43
- `https://raw.githubusercontent.com/modelcontextprotocol/python-sdk/main/README.md`
44
-
45
- ## Server Naming Convention
46
-
47
- Python MCP servers must follow this naming pattern:
48
- - **Format**: `{service}_mcp` (lowercase with underscores)
49
- - **Examples**: `github_mcp`, `jira_mcp`, `stripe_mcp`
50
-
51
- The name should be:
52
- - General (not tied to specific features)
53
- - Descriptive of the service/API being integrated
54
- - Easy to infer from the task description
55
- - Without version numbers or dates
56
-
57
- ## Tool Implementation
58
-
59
- ### Tool Naming
60
-
61
- Use snake_case for tool names (e.g., "search_users", "create_project", "get_channel_info") with clear, action-oriented names.
62
-
63
- **Avoid Naming Conflicts**: Include the service context to prevent overlaps:
64
- - Use "slack_send_message" instead of just "send_message"
65
- - Use "github_create_issue" instead of just "create_issue"
66
- - Use "asana_list_tasks" instead of just "list_tasks"
67
-
68
- ### Tool Structure with FastMCP
69
-
70
- Tools are defined using the `@mcp.tool` decorator with Pydantic models for input validation:
71
-
72
- ```python
73
- from pydantic import BaseModel, Field, ConfigDict
74
- from mcp.server.fastmcp import FastMCP
75
-
76
- # Initialize the MCP server
77
- mcp = FastMCP("example_mcp")
78
-
79
- # Define Pydantic model for input validation
80
- class ServiceToolInput(BaseModel):
81
- '''Input model for service tool operation.'''
82
- model_config = ConfigDict(
83
- str_strip_whitespace=True, # Auto-strip whitespace from strings
84
- validate_assignment=True, # Validate on assignment
85
- extra='forbid' # Forbid extra fields
86
- )
87
-
88
- param1: str = Field(..., description="First parameter description (e.g., 'user123', 'project-abc')", min_length=1, max_length=100)
89
- param2: Optional[int] = Field(default=None, description="Optional integer parameter with constraints", ge=0, le=1000)
90
- tags: Optional[List[str]] = Field(default_factory=list, description="List of tags to apply", max_items=10)
91
-
92
- @mcp.tool(
93
- name="service_tool_name",
94
- annotations={
95
- "title": "Human-Readable Tool Title",
96
- "readOnlyHint": True, # Tool does not modify environment
97
- "destructiveHint": False, # Tool does not perform destructive operations
98
- "idempotentHint": True, # Repeated calls have no additional effect
99
- "openWorldHint": False # Tool does not interact with external entities
100
- }
101
- )
102
- async def service_tool_name(params: ServiceToolInput) -> str:
103
- '''Tool description automatically becomes the 'description' field.
104
-
105
- This tool performs a specific operation on the service. It validates all inputs
106
- using the ServiceToolInput Pydantic model before processing.
107
-
108
- Args:
109
- params (ServiceToolInput): Validated input parameters containing:
110
- - param1 (str): First parameter description
111
- - param2 (Optional[int]): Optional parameter with default
112
- - tags (Optional[List[str]]): List of tags
113
-
114
- Returns:
115
- str: JSON-formatted response containing operation results
116
- '''
117
- # Implementation here
118
- pass
119
- ```
120
-
121
- ## Pydantic v2 Key Features
122
-
123
- - Use `model_config` instead of nested `Config` class
124
- - Use `field_validator` instead of deprecated `validator`
125
- - Use `model_dump()` instead of deprecated `dict()`
126
- - Validators require `@classmethod` decorator
127
- - Type hints are required for validator methods
128
-
129
- ```python
130
- from pydantic import BaseModel, Field, field_validator, ConfigDict
131
-
132
- class CreateUserInput(BaseModel):
133
- model_config = ConfigDict(
134
- str_strip_whitespace=True,
135
- validate_assignment=True
136
- )
137
-
138
- name: str = Field(..., description="User's full name", min_length=1, max_length=100)
139
- email: str = Field(..., description="User's email address", pattern=r'^[\w\.-]+@[\w\.-]+\.\w+$')
140
- age: int = Field(..., description="User's age", ge=0, le=150)
141
-
142
- @field_validator('email')
143
- @classmethod
144
- def validate_email(cls, v: str) -> str:
145
- if not v.strip():
146
- raise ValueError("Email cannot be empty")
147
- return v.lower()
148
- ```
149
-
150
- ## Response Format Options
151
-
152
- Support multiple output formats for flexibility:
153
-
154
- ```python
155
- from enum import Enum
156
-
157
- class ResponseFormat(str, Enum):
158
- '''Output format for tool responses.'''
159
- MARKDOWN = "markdown"
160
- JSON = "json"
161
-
162
- class UserSearchInput(BaseModel):
163
- query: str = Field(..., description="Search query")
164
- response_format: ResponseFormat = Field(
165
- default=ResponseFormat.MARKDOWN,
166
- description="Output format: 'markdown' for human-readable or 'json' for machine-readable"
167
- )
168
- ```
169
-
170
- **Markdown format**:
171
- - Use headers, lists, and formatting for clarity
172
- - Convert timestamps to human-readable format (e.g., "2024-01-15 10:30:00 UTC" instead of epoch)
173
- - Show display names with IDs in parentheses (e.g., "@john.doe (U123456)")
174
- - Omit verbose metadata (e.g., show only one profile image URL, not all sizes)
175
- - Group related information logically
176
-
177
- **JSON format**:
178
- - Return complete, structured data suitable for programmatic processing
179
- - Include all available fields and metadata
180
- - Use consistent field names and types
181
-
182
- ## Pagination Implementation
183
-
184
- For tools that list resources:
185
-
186
- ```python
187
- class ListInput(BaseModel):
188
- limit: Optional[int] = Field(default=20, description="Maximum results to return", ge=1, le=100)
189
- offset: Optional[int] = Field(default=0, description="Number of results to skip for pagination", ge=0)
190
-
191
- async def list_items(params: ListInput) -> str:
192
- # Make API request with pagination
193
- data = await api_request(limit=params.limit, offset=params.offset)
194
-
195
- # Return pagination info
196
- response = {
197
- "total": data["total"],
198
- "count": len(data["items"]),
199
- "offset": params.offset,
200
- "items": data["items"],
201
- "has_more": data["total"] > params.offset + len(data["items"]),
202
- "next_offset": params.offset + len(data["items"]) if data["total"] > params.offset + len(data["items"]) else None
203
- }
204
- return json.dumps(response, indent=2)
205
- ```
206
-
207
- ## Character Limits and Truncation
208
-
209
- Add a CHARACTER_LIMIT constant to prevent overwhelming responses:
210
-
211
- ```python
212
- # At module level
213
- CHARACTER_LIMIT = 25000 # Maximum response size in characters
214
-
215
- async def search_tool(params: SearchInput) -> str:
216
- result = generate_response(data)
217
-
218
- # Check character limit and truncate if needed
219
- if len(result) > CHARACTER_LIMIT:
220
- # Truncate data and add notice
221
- truncated_data = data[:max(1, len(data) // 2)]
222
- response["data"] = truncated_data
223
- response["truncated"] = True
224
- response["truncation_message"] = (
225
- f"Response truncated from {len(data)} to {len(truncated_data)} items. "
226
- f"Use 'offset' parameter or add filters to see more results."
227
- )
228
- result = json.dumps(response, indent=2)
229
-
230
- return result
231
- ```
232
-
233
- ## Error Handling
234
-
235
- Provide clear, actionable error messages:
236
-
237
- ```python
238
- def _handle_api_error(e: Exception) -> str:
239
- '''Consistent error formatting across all tools.'''
240
- if isinstance(e, httpx.HTTPStatusError):
241
- if e.response.status_code == 404:
242
- return "Error: Resource not found. Please check the ID is correct."
243
- elif e.response.status_code == 403:
244
- return "Error: Permission denied. You don't have access to this resource."
245
- elif e.response.status_code == 429:
246
- return "Error: Rate limit exceeded. Please wait before making more requests."
247
- return f"Error: API request failed with status {e.response.status_code}"
248
- elif isinstance(e, httpx.TimeoutException):
249
- return "Error: Request timed out. Please try again."
250
- return f"Error: Unexpected error occurred: {type(e).__name__}"
251
- ```
252
-
253
- ## Shared Utilities
254
-
255
- Extract common functionality into reusable functions:
256
-
257
- ```python
258
- # Shared API request function
259
- async def _make_api_request(endpoint: str, method: str = "GET", **kwargs) -> dict:
260
- '''Reusable function for all API calls.'''
261
- async with httpx.AsyncClient() as client:
262
- response = await client.request(
263
- method,
264
- f"{API_BASE_URL}/{endpoint}",
265
- timeout=30.0,
266
- **kwargs
267
- )
268
- response.raise_for_status()
269
- return response.json()
270
- ```
271
-
272
- ## Async/Await Best Practices
273
-
274
- Always use async/await for network requests and I/O operations:
275
-
276
- ```python
277
- # Good: Async network request
278
- async def fetch_data(resource_id: str) -> dict:
279
- async with httpx.AsyncClient() as client:
280
- response = await client.get(f"{API_URL}/resource/{resource_id}")
281
- response.raise_for_status()
282
- return response.json()
283
-
284
- # Bad: Synchronous request
285
- def fetch_data(resource_id: str) -> dict:
286
- response = requests.get(f"{API_URL}/resource/{resource_id}") # Blocks
287
- return response.json()
288
- ```
289
-
290
- ## Type Hints
291
-
292
- Use type hints throughout:
293
-
294
- ```python
295
- from typing import Optional, List, Dict, Any
296
-
297
- async def get_user(user_id: str) -> Dict[str, Any]:
298
- data = await fetch_user(user_id)
299
- return {"id": data["id"], "name": data["name"]}
300
- ```
301
-
302
- ## Tool Docstrings
303
-
304
- Every tool must have comprehensive docstrings with explicit type information:
305
-
306
- ```python
307
- async def search_users(params: UserSearchInput) -> str:
308
- '''
309
- Search for users in the Example system by name, email, or team.
310
-
311
- This tool searches across all user profiles in the Example platform,
312
- supporting partial matches and various search filters. It does NOT
313
- create or modify users, only searches existing ones.
314
-
315
- Args:
316
- params (UserSearchInput): Validated input parameters containing:
317
- - query (str): Search string to match against names/emails (e.g., "john", "@example.com", "team:marketing")
318
- - limit (Optional[int]): Maximum results to return, between 1-100 (default: 20)
319
- - offset (Optional[int]): Number of results to skip for pagination (default: 0)
320
-
321
- Returns:
322
- str: JSON-formatted string containing search results with the following schema:
323
-
324
- Success response:
325
- {
326
- "total": int, # Total number of matches found
327
- "count": int, # Number of results in this response
328
- "offset": int, # Current pagination offset
329
- "users": [
330
- {
331
- "id": str, # User ID (e.g., "U123456789")
332
- "name": str, # Full name (e.g., "John Doe")
333
- "email": str, # Email address (e.g., "john@example.com")
334
- "team": str # Team name (e.g., "Marketing") - optional
335
- }
336
- ]
337
- }
338
-
339
- Error response:
340
- "Error: <error message>" or "No users found matching '<query>'"
341
-
342
- Examples:
343
- - Use when: "Find all marketing team members" -> params with query="team:marketing"
344
- - Use when: "Search for John's account" -> params with query="john"
345
- - Don't use when: You need to create a user (use example_create_user instead)
346
- - Don't use when: You have a user ID and need full details (use example_get_user instead)
347
-
348
- Error Handling:
349
- - Input validation errors are handled by Pydantic model
350
- - Returns "Error: Rate limit exceeded" if too many requests (429 status)
351
- - Returns "Error: Invalid API authentication" if API key is invalid (401 status)
352
- - Returns formatted list of results or "No users found matching 'query'"
353
- '''
354
- ```
355
-
356
- ## Complete Example
357
-
358
- See below for a complete Python MCP server example:
359
-
360
- ```python
361
- #!/usr/bin/env python3
362
- '''
363
- MCP Server for Example Service.
364
-
365
- This server provides tools to interact with Example API, including user search,
366
- project management, and data export capabilities.
367
- '''
368
-
369
- from typing import Optional, List, Dict, Any
370
- from enum import Enum
371
- import httpx
372
- from pydantic import BaseModel, Field, field_validator, ConfigDict
373
- from mcp.server.fastmcp import FastMCP
374
-
375
- # Initialize the MCP server
376
- mcp = FastMCP("example_mcp")
377
-
378
- # Constants
379
- API_BASE_URL = "https://api.example.com/v1"
380
- CHARACTER_LIMIT = 25000 # Maximum response size in characters
381
-
382
- # Enums
383
- class ResponseFormat(str, Enum):
384
- '''Output format for tool responses.'''
385
- MARKDOWN = "markdown"
386
- JSON = "json"
387
-
388
- # Pydantic Models for Input Validation
389
- class UserSearchInput(BaseModel):
390
- '''Input model for user search operations.'''
391
- model_config = ConfigDict(
392
- str_strip_whitespace=True,
393
- validate_assignment=True
394
- )
395
-
396
- query: str = Field(..., description="Search string to match against names/emails", min_length=2, max_length=200)
397
- limit: Optional[int] = Field(default=20, description="Maximum results to return", ge=1, le=100)
398
- offset: Optional[int] = Field(default=0, description="Number of results to skip for pagination", ge=0)
399
- response_format: ResponseFormat = Field(default=ResponseFormat.MARKDOWN, description="Output format")
400
-
401
- @field_validator('query')
402
- @classmethod
403
- def validate_query(cls, v: str) -> str:
404
- if not v.strip():
405
- raise ValueError("Query cannot be empty or whitespace only")
406
- return v.strip()
407
-
408
- # Shared utility functions
409
- async def _make_api_request(endpoint: str, method: str = "GET", **kwargs) -> dict:
410
- '''Reusable function for all API calls.'''
411
- async with httpx.AsyncClient() as client:
412
- response = await client.request(
413
- method,
414
- f"{API_BASE_URL}/{endpoint}",
415
- timeout=30.0,
416
- **kwargs
417
- )
418
- response.raise_for_status()
419
- return response.json()
420
-
421
- def _handle_api_error(e: Exception) -> str:
422
- '''Consistent error formatting across all tools.'''
423
- if isinstance(e, httpx.HTTPStatusError):
424
- if e.response.status_code == 404:
425
- return "Error: Resource not found. Please check the ID is correct."
426
- elif e.response.status_code == 403:
427
- return "Error: Permission denied. You don't have access to this resource."
428
- elif e.response.status_code == 429:
429
- return "Error: Rate limit exceeded. Please wait before making more requests."
430
- return f"Error: API request failed with status {e.response.status_code}"
431
- elif isinstance(e, httpx.TimeoutException):
432
- return "Error: Request timed out. Please try again."
433
- return f"Error: Unexpected error occurred: {type(e).__name__}"
434
-
435
- # Tool definitions
436
- @mcp.tool(
437
- name="example_search_users",
438
- annotations={
439
- "title": "Search Example Users",
440
- "readOnlyHint": True,
441
- "destructiveHint": False,
442
- "idempotentHint": True,
443
- "openWorldHint": True
444
- }
445
- )
446
- async def example_search_users(params: UserSearchInput) -> str:
447
- '''Search for users in the Example system by name, email, or team.
448
-
449
- [Full docstring as shown above]
450
- '''
451
- try:
452
- # Make API request using validated parameters
453
- data = await _make_api_request(
454
- "users/search",
455
- params={
456
- "q": params.query,
457
- "limit": params.limit,
458
- "offset": params.offset
459
- }
460
- )
461
-
462
- users = data.get("users", [])
463
- total = data.get("total", 0)
464
-
465
- if not users:
466
- return f"No users found matching '{params.query}'"
467
-
468
- # Format response based on requested format
469
- if params.response_format == ResponseFormat.MARKDOWN:
470
- lines = [f"# User Search Results: '{params.query}'", ""]
471
- lines.append(f"Found {total} users (showing {len(users)})")
472
- lines.append("")
473
-
474
- for user in users:
475
- lines.append(f"## {user['name']} ({user['id']})")
476
- lines.append(f"- **Email**: {user['email']}")
477
- if user.get('team'):
478
- lines.append(f"- **Team**: {user['team']}")
479
- lines.append("")
480
-
481
- return "\n".join(lines)
482
-
483
- else:
484
- # Machine-readable JSON format
485
- import json
486
- response = {
487
- "total": total,
488
- "count": len(users),
489
- "offset": params.offset,
490
- "users": users
491
- }
492
- return json.dumps(response, indent=2)
493
-
494
- except Exception as e:
495
- return _handle_api_error(e)
496
-
497
- if __name__ == "__main__":
498
- mcp.run()
499
- ```
500
-
501
- ---
502
-
503
- ## Advanced FastMCP Features
504
-
505
- ### Context Parameter Injection
506
-
507
- FastMCP can automatically inject a `Context` parameter into tools for advanced capabilities like logging, progress reporting, resource reading, and user interaction:
508
-
509
- ```python
510
- from mcp.server.fastmcp import FastMCP, Context
511
-
512
- mcp = FastMCP("example_mcp")
513
-
514
- @mcp.tool()
515
- async def advanced_search(query: str, ctx: Context) -> str:
516
- '''Advanced tool with context access for logging and progress.'''
517
-
518
- # Report progress for long operations
519
- await ctx.report_progress(0.25, "Starting search...")
520
-
521
- # Log information for debugging
522
- await ctx.log_info("Processing query", {"query": query, "timestamp": datetime.now()})
523
-
524
- # Perform search
525
- results = await search_api(query)
526
- await ctx.report_progress(0.75, "Formatting results...")
527
-
528
- # Access server configuration
529
- server_name = ctx.fastmcp.name
530
-
531
- return format_results(results)
532
-
533
- @mcp.tool()
534
- async def interactive_tool(resource_id: str, ctx: Context) -> str:
535
- '''Tool that can request additional input from users.'''
536
-
537
- # Request sensitive information when needed
538
- api_key = await ctx.elicit(
539
- prompt="Please provide your API key:",
540
- input_type="password"
541
- )
542
-
543
- # Use the provided key
544
- return await api_call(resource_id, api_key)
545
- ```
546
-
547
- **Context capabilities:**
548
- - `ctx.report_progress(progress, message)` - Report progress for long operations
549
- - `ctx.log_info(message, data)` / `ctx.log_error()` / `ctx.log_debug()` - Logging
550
- - `ctx.elicit(prompt, input_type)` - Request input from users
551
- - `ctx.fastmcp.name` - Access server configuration
552
- - `ctx.read_resource(uri)` - Read MCP resources
553
-
554
- ### Resource Registration
555
-
556
- Expose data as resources for efficient, template-based access:
557
-
558
- ```python
559
- @mcp.resource("file://documents/{name}")
560
- async def get_document(name: str) -> str:
561
- '''Expose documents as MCP resources.
562
-
563
- Resources are useful for static or semi-static data that doesn't
564
- require complex parameters. They use URI templates for flexible access.
565
- '''
566
- document_path = f"./docs/{name}"
567
- with open(document_path, "r") as f:
568
- return f.read()
569
-
570
- @mcp.resource("config://settings/{key}")
571
- async def get_setting(key: str, ctx: Context) -> str:
572
- '''Expose configuration as resources with context.'''
573
- settings = await load_settings()
574
- return json.dumps(settings.get(key, {}))
575
- ```
576
-
577
- **When to use Resources vs Tools:**
578
- - **Resources**: For data access with simple parameters (URI templates)
579
- - **Tools**: For complex operations with validation and business logic
580
-
581
- ### Structured Output Types
582
-
583
- FastMCP supports multiple return types beyond strings:
584
-
585
- ```python
586
- from typing import TypedDict
587
- from dataclasses import dataclass
588
- from pydantic import BaseModel
589
-
590
- # TypedDict for structured returns
591
- class UserData(TypedDict):
592
- id: str
593
- name: str
594
- email: str
595
-
596
- @mcp.tool()
597
- async def get_user_typed(user_id: str) -> UserData:
598
- '''Returns structured data - FastMCP handles serialization.'''
599
- return {"id": user_id, "name": "John Doe", "email": "john@example.com"}
600
-
601
- # Pydantic models for complex validation
602
- class DetailedUser(BaseModel):
603
- id: str
604
- name: str
605
- email: str
606
- created_at: datetime
607
- metadata: Dict[str, Any]
608
-
609
- @mcp.tool()
610
- async def get_user_detailed(user_id: str) -> DetailedUser:
611
- '''Returns Pydantic model - automatically generates schema.'''
612
- user = await fetch_user(user_id)
613
- return DetailedUser(**user)
614
- ```
615
-
616
- ### Lifespan Management
617
-
618
- Initialize resources that persist across requests:
619
-
620
- ```python
621
- from contextlib import asynccontextmanager
622
-
623
- @asynccontextmanager
624
- async def app_lifespan():
625
- '''Manage resources that live for the server's lifetime.'''
626
- # Initialize connections, load config, etc.
627
- db = await connect_to_database()
628
- config = load_configuration()
629
-
630
- # Make available to all tools
631
- yield {"db": db, "config": config}
632
-
633
- # Cleanup on shutdown
634
- await db.close()
635
-
636
- mcp = FastMCP("example_mcp", lifespan=app_lifespan)
637
-
638
- @mcp.tool()
639
- async def query_data(query: str, ctx: Context) -> str:
640
- '''Access lifespan resources through context.'''
641
- db = ctx.request_context.lifespan_state["db"]
642
- results = await db.query(query)
643
- return format_results(results)
644
- ```
645
-
646
- ### Multiple Transport Options
647
-
648
- FastMCP supports different transport mechanisms:
649
-
650
- ```python
651
- # Default: Stdio transport (for CLI tools)
652
- if __name__ == "__main__":
653
- mcp.run()
654
-
655
- # HTTP transport (for web services)
656
- if __name__ == "__main__":
657
- mcp.run(transport="streamable_http", port=8000)
658
-
659
- # SSE transport (for real-time updates)
660
- if __name__ == "__main__":
661
- mcp.run(transport="sse", port=8000)
662
- ```
663
-
664
- **Transport selection:**
665
- - **Stdio**: Command-line tools, subprocess integration
666
- - **HTTP**: Web services, remote access, multiple clients
667
- - **SSE**: Real-time updates, push notifications
668
-
669
- ---
670
-
671
- ## Code Best Practices
672
-
673
- ### Code Composability and Reusability
674
-
675
- Your implementation MUST prioritize composability and code reuse:
676
-
677
- 1. **Extract Common Functionality**:
678
- - Create reusable helper functions for operations used across multiple tools
679
- - Build shared API clients for HTTP requests instead of duplicating code
680
- - Centralize error handling logic in utility functions
681
- - Extract business logic into dedicated functions that can be composed
682
- - Extract shared markdown or JSON field selection & formatting functionality
683
-
684
- 2. **Avoid Duplication**:
685
- - NEVER copy-paste similar code between tools
686
- - If you find yourself writing similar logic twice, extract it into a function
687
- - Common operations like pagination, filtering, field selection, and formatting should be shared
688
- - Authentication/authorization logic should be centralized
689
-
690
- ### Python-Specific Best Practices
691
-
692
- 1. **Use Type Hints**: Always include type annotations for function parameters and return values
693
- 2. **Pydantic Models**: Define clear Pydantic models for all input validation
694
- 3. **Avoid Manual Validation**: Let Pydantic handle input validation with constraints
695
- 4. **Proper Imports**: Group imports (standard library, third-party, local)
696
- 5. **Error Handling**: Use specific exception types (httpx.HTTPStatusError, not generic Exception)
697
- 6. **Async Context Managers**: Use `async with` for resources that need cleanup
698
- 7. **Constants**: Define module-level constants in UPPER_CASE
699
-
700
- ## Quality Checklist
701
-
702
- Before finalizing your Python MCP server implementation, ensure:
703
-
704
- ### Strategic Design
705
- - [ ] Tools enable complete workflows, not just API endpoint wrappers
706
- - [ ] Tool names reflect natural task subdivisions
707
- - [ ] Response formats optimize for agent context efficiency
708
- - [ ] Human-readable identifiers used where appropriate
709
- - [ ] Error messages guide agents toward correct usage
710
-
711
- ### Implementation Quality
712
- - [ ] FOCUSED IMPLEMENTATION: Most important and valuable tools implemented
713
- - [ ] All tools have descriptive names and documentation
714
- - [ ] Return types are consistent across similar operations
715
- - [ ] Error handling is implemented for all external calls
716
- - [ ] Server name follows format: `{service}_mcp`
717
- - [ ] All network operations use async/await
718
- - [ ] Common functionality is extracted into reusable functions
719
- - [ ] Error messages are clear, actionable, and educational
720
- - [ ] Outputs are properly validated and formatted
721
-
722
- ### Tool Configuration
723
- - [ ] All tools implement 'name' and 'annotations' in the decorator
724
- - [ ] Annotations correctly set (readOnlyHint, destructiveHint, idempotentHint, openWorldHint)
725
- - [ ] All tools use Pydantic BaseModel for input validation with Field() definitions
726
- - [ ] All Pydantic Fields have explicit types and descriptions with constraints
727
- - [ ] All tools have comprehensive docstrings with explicit input/output types
728
- - [ ] Docstrings include complete schema structure for dict/JSON returns
729
- - [ ] Pydantic models handle input validation (no manual validation needed)
730
-
731
- ### Advanced Features (where applicable)
732
- - [ ] Context injection used for logging, progress, or elicitation
733
- - [ ] Resources registered for appropriate data endpoints
734
- - [ ] Lifespan management implemented for persistent connections
735
- - [ ] Structured output types used (TypedDict, Pydantic models)
736
- - [ ] Appropriate transport configured (stdio, HTTP, SSE)
737
-
738
- ### Code Quality
739
- - [ ] File includes proper imports including Pydantic imports
740
- - [ ] Pagination is properly implemented where applicable
741
- - [ ] Large responses check CHARACTER_LIMIT and truncate with clear messages
742
- - [ ] Filtering options are provided for potentially large result sets
743
- - [ ] All async functions are properly defined with `async def`
744
- - [ ] HTTP client usage follows async patterns with proper context managers
745
- - [ ] Type hints are used throughout the code
746
- - [ ] Constants are defined at module level in UPPER_CASE
747
-
748
- ### Testing
749
- - [ ] Server runs successfully: `python your_server.py --help`
750
- - [ ] All imports resolve correctly
751
- - [ ] Sample tool calls work as expected
1
+ # Python MCP Server Implementation Guide
2
+
3
+ ## Overview
4
+
5
+ This document provides Python-specific best practices and examples for implementing MCP servers using the MCP Python SDK. It covers server setup, tool registration patterns, input validation with Pydantic, error handling, and complete working examples.
6
+
7
+ ---
8
+
9
+ ## Quick Reference
10
+
11
+ ### Key Imports
12
+ ```python
13
+ from mcp.server.fastmcp import FastMCP
14
+ from pydantic import BaseModel, Field, field_validator, ConfigDict
15
+ from typing import Optional, List, Dict, Any
16
+ from enum import Enum
17
+ import httpx
18
+ ```
19
+
20
+ ### Server Initialization
21
+ ```python
22
+ mcp = FastMCP("service_mcp")
23
+ ```
24
+
25
+ ### Tool Registration Pattern
26
+ ```python
27
+ @mcp.tool(name="tool_name", annotations={...})
28
+ async def tool_function(params: InputModel) -> str:
29
+ # Implementation
30
+ pass
31
+ ```
32
+
33
+ ---
34
+
35
+ ## MCP Python SDK and FastMCP
36
+
37
+ The official MCP Python SDK provides FastMCP, a high-level framework for building MCP servers. It provides:
38
+ - Automatic description and inputSchema generation from function signatures and docstrings
39
+ - Pydantic model integration for input validation
40
+ - Decorator-based tool registration with `@mcp.tool`
41
+
42
+ **For complete SDK documentation, use WebFetch to load:**
43
+ `https://raw.githubusercontent.com/modelcontextprotocol/python-sdk/main/README.md`
44
+
45
+ ## Server Naming Convention
46
+
47
+ Python MCP servers must follow this naming pattern:
48
+ - **Format**: `{service}_mcp` (lowercase with underscores)
49
+ - **Examples**: `github_mcp`, `jira_mcp`, `stripe_mcp`
50
+
51
+ The name should be:
52
+ - General (not tied to specific features)
53
+ - Descriptive of the service/API being integrated
54
+ - Easy to infer from the task description
55
+ - Without version numbers or dates
56
+
57
+ ## Tool Implementation
58
+
59
+ ### Tool Naming
60
+
61
+ Use snake_case for tool names (e.g., "search_users", "create_project", "get_channel_info") with clear, action-oriented names.
62
+
63
+ **Avoid Naming Conflicts**: Include the service context to prevent overlaps:
64
+ - Use "slack_send_message" instead of just "send_message"
65
+ - Use "github_create_issue" instead of just "create_issue"
66
+ - Use "asana_list_tasks" instead of just "list_tasks"
67
+
68
+ ### Tool Structure with FastMCP
69
+
70
+ Tools are defined using the `@mcp.tool` decorator with Pydantic models for input validation:
71
+
72
+ ```python
73
+ from pydantic import BaseModel, Field, ConfigDict
74
+ from mcp.server.fastmcp import FastMCP
75
+
76
+ # Initialize the MCP server
77
+ mcp = FastMCP("example_mcp")
78
+
79
+ # Define Pydantic model for input validation
80
+ class ServiceToolInput(BaseModel):
81
+ '''Input model for service tool operation.'''
82
+ model_config = ConfigDict(
83
+ str_strip_whitespace=True, # Auto-strip whitespace from strings
84
+ validate_assignment=True, # Validate on assignment
85
+ extra='forbid' # Forbid extra fields
86
+ )
87
+
88
+ param1: str = Field(..., description="First parameter description (e.g., 'user123', 'project-abc')", min_length=1, max_length=100)
89
+ param2: Optional[int] = Field(default=None, description="Optional integer parameter with constraints", ge=0, le=1000)
90
+ tags: Optional[List[str]] = Field(default_factory=list, description="List of tags to apply", max_items=10)
91
+
92
+ @mcp.tool(
93
+ name="service_tool_name",
94
+ annotations={
95
+ "title": "Human-Readable Tool Title",
96
+ "readOnlyHint": True, # Tool does not modify environment
97
+ "destructiveHint": False, # Tool does not perform destructive operations
98
+ "idempotentHint": True, # Repeated calls have no additional effect
99
+ "openWorldHint": False # Tool does not interact with external entities
100
+ }
101
+ )
102
+ async def service_tool_name(params: ServiceToolInput) -> str:
103
+ '''Tool description automatically becomes the 'description' field.
104
+
105
+ This tool performs a specific operation on the service. It validates all inputs
106
+ using the ServiceToolInput Pydantic model before processing.
107
+
108
+ Args:
109
+ params (ServiceToolInput): Validated input parameters containing:
110
+ - param1 (str): First parameter description
111
+ - param2 (Optional[int]): Optional parameter with default
112
+ - tags (Optional[List[str]]): List of tags
113
+
114
+ Returns:
115
+ str: JSON-formatted response containing operation results
116
+ '''
117
+ # Implementation here
118
+ pass
119
+ ```
120
+
121
+ ## Pydantic v2 Key Features
122
+
123
+ - Use `model_config` instead of nested `Config` class
124
+ - Use `field_validator` instead of deprecated `validator`
125
+ - Use `model_dump()` instead of deprecated `dict()`
126
+ - Validators require `@classmethod` decorator
127
+ - Type hints are required for validator methods
128
+
129
+ ```python
130
+ from pydantic import BaseModel, Field, field_validator, ConfigDict
131
+
132
+ class CreateUserInput(BaseModel):
133
+ model_config = ConfigDict(
134
+ str_strip_whitespace=True,
135
+ validate_assignment=True
136
+ )
137
+
138
+ name: str = Field(..., description="User's full name", min_length=1, max_length=100)
139
+ email: str = Field(..., description="User's email address", pattern=r'^[\w\.-]+@[\w\.-]+\.\w+$')
140
+ age: int = Field(..., description="User's age", ge=0, le=150)
141
+
142
+ @field_validator('email')
143
+ @classmethod
144
+ def validate_email(cls, v: str) -> str:
145
+ if not v.strip():
146
+ raise ValueError("Email cannot be empty")
147
+ return v.lower()
148
+ ```
149
+
150
+ ## Response Format Options
151
+
152
+ Support multiple output formats for flexibility:
153
+
154
+ ```python
155
+ from enum import Enum
156
+
157
+ class ResponseFormat(str, Enum):
158
+ '''Output format for tool responses.'''
159
+ MARKDOWN = "markdown"
160
+ JSON = "json"
161
+
162
+ class UserSearchInput(BaseModel):
163
+ query: str = Field(..., description="Search query")
164
+ response_format: ResponseFormat = Field(
165
+ default=ResponseFormat.MARKDOWN,
166
+ description="Output format: 'markdown' for human-readable or 'json' for machine-readable"
167
+ )
168
+ ```
169
+
170
+ **Markdown format**:
171
+ - Use headers, lists, and formatting for clarity
172
+ - Convert timestamps to human-readable format (e.g., "2024-01-15 10:30:00 UTC" instead of epoch)
173
+ - Show display names with IDs in parentheses (e.g., "@john.doe (U123456)")
174
+ - Omit verbose metadata (e.g., show only one profile image URL, not all sizes)
175
+ - Group related information logically
176
+
177
+ **JSON format**:
178
+ - Return complete, structured data suitable for programmatic processing
179
+ - Include all available fields and metadata
180
+ - Use consistent field names and types
181
+
182
+ ## Pagination Implementation
183
+
184
+ For tools that list resources:
185
+
186
+ ```python
187
+ class ListInput(BaseModel):
188
+ limit: Optional[int] = Field(default=20, description="Maximum results to return", ge=1, le=100)
189
+ offset: Optional[int] = Field(default=0, description="Number of results to skip for pagination", ge=0)
190
+
191
+ async def list_items(params: ListInput) -> str:
192
+ # Make API request with pagination
193
+ data = await api_request(limit=params.limit, offset=params.offset)
194
+
195
+ # Return pagination info
196
+ response = {
197
+ "total": data["total"],
198
+ "count": len(data["items"]),
199
+ "offset": params.offset,
200
+ "items": data["items"],
201
+ "has_more": data["total"] > params.offset + len(data["items"]),
202
+ "next_offset": params.offset + len(data["items"]) if data["total"] > params.offset + len(data["items"]) else None
203
+ }
204
+ return json.dumps(response, indent=2)
205
+ ```
206
+
207
+ ## Character Limits and Truncation
208
+
209
+ Add a CHARACTER_LIMIT constant to prevent overwhelming responses:
210
+
211
+ ```python
212
+ # At module level
213
+ CHARACTER_LIMIT = 25000 # Maximum response size in characters
214
+
215
+ async def search_tool(params: SearchInput) -> str:
216
+ result = generate_response(data)
217
+
218
+ # Check character limit and truncate if needed
219
+ if len(result) > CHARACTER_LIMIT:
220
+ # Truncate data and add notice
221
+ truncated_data = data[:max(1, len(data) // 2)]
222
+ response["data"] = truncated_data
223
+ response["truncated"] = True
224
+ response["truncation_message"] = (
225
+ f"Response truncated from {len(data)} to {len(truncated_data)} items. "
226
+ f"Use 'offset' parameter or add filters to see more results."
227
+ )
228
+ result = json.dumps(response, indent=2)
229
+
230
+ return result
231
+ ```
232
+
233
+ ## Error Handling
234
+
235
+ Provide clear, actionable error messages:
236
+
237
+ ```python
238
+ def _handle_api_error(e: Exception) -> str:
239
+ '''Consistent error formatting across all tools.'''
240
+ if isinstance(e, httpx.HTTPStatusError):
241
+ if e.response.status_code == 404:
242
+ return "Error: Resource not found. Please check the ID is correct."
243
+ elif e.response.status_code == 403:
244
+ return "Error: Permission denied. You don't have access to this resource."
245
+ elif e.response.status_code == 429:
246
+ return "Error: Rate limit exceeded. Please wait before making more requests."
247
+ return f"Error: API request failed with status {e.response.status_code}"
248
+ elif isinstance(e, httpx.TimeoutException):
249
+ return "Error: Request timed out. Please try again."
250
+ return f"Error: Unexpected error occurred: {type(e).__name__}"
251
+ ```
252
+
253
+ ## Shared Utilities
254
+
255
+ Extract common functionality into reusable functions:
256
+
257
+ ```python
258
+ # Shared API request function
259
+ async def _make_api_request(endpoint: str, method: str = "GET", **kwargs) -> dict:
260
+ '''Reusable function for all API calls.'''
261
+ async with httpx.AsyncClient() as client:
262
+ response = await client.request(
263
+ method,
264
+ f"{API_BASE_URL}/{endpoint}",
265
+ timeout=30.0,
266
+ **kwargs
267
+ )
268
+ response.raise_for_status()
269
+ return response.json()
270
+ ```
271
+
272
+ ## Async/Await Best Practices
273
+
274
+ Always use async/await for network requests and I/O operations:
275
+
276
+ ```python
277
+ # Good: Async network request
278
+ async def fetch_data(resource_id: str) -> dict:
279
+ async with httpx.AsyncClient() as client:
280
+ response = await client.get(f"{API_URL}/resource/{resource_id}")
281
+ response.raise_for_status()
282
+ return response.json()
283
+
284
+ # Bad: Synchronous request
285
+ def fetch_data(resource_id: str) -> dict:
286
+ response = requests.get(f"{API_URL}/resource/{resource_id}") # Blocks
287
+ return response.json()
288
+ ```
289
+
290
+ ## Type Hints
291
+
292
+ Use type hints throughout:
293
+
294
+ ```python
295
+ from typing import Optional, List, Dict, Any
296
+
297
+ async def get_user(user_id: str) -> Dict[str, Any]:
298
+ data = await fetch_user(user_id)
299
+ return {"id": data["id"], "name": data["name"]}
300
+ ```
301
+
302
+ ## Tool Docstrings
303
+
304
+ Every tool must have comprehensive docstrings with explicit type information:
305
+
306
+ ```python
307
+ async def search_users(params: UserSearchInput) -> str:
308
+ '''
309
+ Search for users in the Example system by name, email, or team.
310
+
311
+ This tool searches across all user profiles in the Example platform,
312
+ supporting partial matches and various search filters. It does NOT
313
+ create or modify users, only searches existing ones.
314
+
315
+ Args:
316
+ params (UserSearchInput): Validated input parameters containing:
317
+ - query (str): Search string to match against names/emails (e.g., "john", "@example.com", "team:marketing")
318
+ - limit (Optional[int]): Maximum results to return, between 1-100 (default: 20)
319
+ - offset (Optional[int]): Number of results to skip for pagination (default: 0)
320
+
321
+ Returns:
322
+ str: JSON-formatted string containing search results with the following schema:
323
+
324
+ Success response:
325
+ {
326
+ "total": int, # Total number of matches found
327
+ "count": int, # Number of results in this response
328
+ "offset": int, # Current pagination offset
329
+ "users": [
330
+ {
331
+ "id": str, # User ID (e.g., "U123456789")
332
+ "name": str, # Full name (e.g., "John Doe")
333
+ "email": str, # Email address (e.g., "john@example.com")
334
+ "team": str # Team name (e.g., "Marketing") - optional
335
+ }
336
+ ]
337
+ }
338
+
339
+ Error response:
340
+ "Error: <error message>" or "No users found matching '<query>'"
341
+
342
+ Examples:
343
+ - Use when: "Find all marketing team members" -> params with query="team:marketing"
344
+ - Use when: "Search for John's account" -> params with query="john"
345
+ - Don't use when: You need to create a user (use example_create_user instead)
346
+ - Don't use when: You have a user ID and need full details (use example_get_user instead)
347
+
348
+ Error Handling:
349
+ - Input validation errors are handled by Pydantic model
350
+ - Returns "Error: Rate limit exceeded" if too many requests (429 status)
351
+ - Returns "Error: Invalid API authentication" if API key is invalid (401 status)
352
+ - Returns formatted list of results or "No users found matching 'query'"
353
+ '''
354
+ ```
355
+
356
+ ## Complete Example
357
+
358
+ See below for a complete Python MCP server example:
359
+
360
+ ```python
361
+ #!/usr/bin/env python3
362
+ '''
363
+ MCP Server for Example Service.
364
+
365
+ This server provides tools to interact with Example API, including user search,
366
+ project management, and data export capabilities.
367
+ '''
368
+
369
+ from typing import Optional, List, Dict, Any
370
+ from enum import Enum
371
+ import httpx
372
+ from pydantic import BaseModel, Field, field_validator, ConfigDict
373
+ from mcp.server.fastmcp import FastMCP
374
+
375
+ # Initialize the MCP server
376
+ mcp = FastMCP("example_mcp")
377
+
378
+ # Constants
379
+ API_BASE_URL = "https://api.example.com/v1"
380
+ CHARACTER_LIMIT = 25000 # Maximum response size in characters
381
+
382
+ # Enums
383
+ class ResponseFormat(str, Enum):
384
+ '''Output format for tool responses.'''
385
+ MARKDOWN = "markdown"
386
+ JSON = "json"
387
+
388
+ # Pydantic Models for Input Validation
389
+ class UserSearchInput(BaseModel):
390
+ '''Input model for user search operations.'''
391
+ model_config = ConfigDict(
392
+ str_strip_whitespace=True,
393
+ validate_assignment=True
394
+ )
395
+
396
+ query: str = Field(..., description="Search string to match against names/emails", min_length=2, max_length=200)
397
+ limit: Optional[int] = Field(default=20, description="Maximum results to return", ge=1, le=100)
398
+ offset: Optional[int] = Field(default=0, description="Number of results to skip for pagination", ge=0)
399
+ response_format: ResponseFormat = Field(default=ResponseFormat.MARKDOWN, description="Output format")
400
+
401
+ @field_validator('query')
402
+ @classmethod
403
+ def validate_query(cls, v: str) -> str:
404
+ if not v.strip():
405
+ raise ValueError("Query cannot be empty or whitespace only")
406
+ return v.strip()
407
+
408
+ # Shared utility functions
409
+ async def _make_api_request(endpoint: str, method: str = "GET", **kwargs) -> dict:
410
+ '''Reusable function for all API calls.'''
411
+ async with httpx.AsyncClient() as client:
412
+ response = await client.request(
413
+ method,
414
+ f"{API_BASE_URL}/{endpoint}",
415
+ timeout=30.0,
416
+ **kwargs
417
+ )
418
+ response.raise_for_status()
419
+ return response.json()
420
+
421
+ def _handle_api_error(e: Exception) -> str:
422
+ '''Consistent error formatting across all tools.'''
423
+ if isinstance(e, httpx.HTTPStatusError):
424
+ if e.response.status_code == 404:
425
+ return "Error: Resource not found. Please check the ID is correct."
426
+ elif e.response.status_code == 403:
427
+ return "Error: Permission denied. You don't have access to this resource."
428
+ elif e.response.status_code == 429:
429
+ return "Error: Rate limit exceeded. Please wait before making more requests."
430
+ return f"Error: API request failed with status {e.response.status_code}"
431
+ elif isinstance(e, httpx.TimeoutException):
432
+ return "Error: Request timed out. Please try again."
433
+ return f"Error: Unexpected error occurred: {type(e).__name__}"
434
+
435
+ # Tool definitions
436
+ @mcp.tool(
437
+ name="example_search_users",
438
+ annotations={
439
+ "title": "Search Example Users",
440
+ "readOnlyHint": True,
441
+ "destructiveHint": False,
442
+ "idempotentHint": True,
443
+ "openWorldHint": True
444
+ }
445
+ )
446
+ async def example_search_users(params: UserSearchInput) -> str:
447
+ '''Search for users in the Example system by name, email, or team.
448
+
449
+ [Full docstring as shown above]
450
+ '''
451
+ try:
452
+ # Make API request using validated parameters
453
+ data = await _make_api_request(
454
+ "users/search",
455
+ params={
456
+ "q": params.query,
457
+ "limit": params.limit,
458
+ "offset": params.offset
459
+ }
460
+ )
461
+
462
+ users = data.get("users", [])
463
+ total = data.get("total", 0)
464
+
465
+ if not users:
466
+ return f"No users found matching '{params.query}'"
467
+
468
+ # Format response based on requested format
469
+ if params.response_format == ResponseFormat.MARKDOWN:
470
+ lines = [f"# User Search Results: '{params.query}'", ""]
471
+ lines.append(f"Found {total} users (showing {len(users)})")
472
+ lines.append("")
473
+
474
+ for user in users:
475
+ lines.append(f"## {user['name']} ({user['id']})")
476
+ lines.append(f"- **Email**: {user['email']}")
477
+ if user.get('team'):
478
+ lines.append(f"- **Team**: {user['team']}")
479
+ lines.append("")
480
+
481
+ return "\n".join(lines)
482
+
483
+ else:
484
+ # Machine-readable JSON format
485
+ import json
486
+ response = {
487
+ "total": total,
488
+ "count": len(users),
489
+ "offset": params.offset,
490
+ "users": users
491
+ }
492
+ return json.dumps(response, indent=2)
493
+
494
+ except Exception as e:
495
+ return _handle_api_error(e)
496
+
497
+ if __name__ == "__main__":
498
+ mcp.run()
499
+ ```
500
+
501
+ ---
502
+
503
+ ## Advanced FastMCP Features
504
+
505
+ ### Context Parameter Injection
506
+
507
+ FastMCP can automatically inject a `Context` parameter into tools for advanced capabilities like logging, progress reporting, resource reading, and user interaction:
508
+
509
+ ```python
510
+ from mcp.server.fastmcp import FastMCP, Context
511
+
512
+ mcp = FastMCP("example_mcp")
513
+
514
+ @mcp.tool()
515
+ async def advanced_search(query: str, ctx: Context) -> str:
516
+ '''Advanced tool with context access for logging and progress.'''
517
+
518
+ # Report progress for long operations
519
+ await ctx.report_progress(0.25, "Starting search...")
520
+
521
+ # Log information for debugging
522
+ await ctx.log_info("Processing query", {"query": query, "timestamp": datetime.now()})
523
+
524
+ # Perform search
525
+ results = await search_api(query)
526
+ await ctx.report_progress(0.75, "Formatting results...")
527
+
528
+ # Access server configuration
529
+ server_name = ctx.fastmcp.name
530
+
531
+ return format_results(results)
532
+
533
+ @mcp.tool()
534
+ async def interactive_tool(resource_id: str, ctx: Context) -> str:
535
+ '''Tool that can request additional input from users.'''
536
+
537
+ # Request sensitive information when needed
538
+ api_key = await ctx.elicit(
539
+ prompt="Please provide your API key:",
540
+ input_type="password"
541
+ )
542
+
543
+ # Use the provided key
544
+ return await api_call(resource_id, api_key)
545
+ ```
546
+
547
+ **Context capabilities:**
548
+ - `ctx.report_progress(progress, message)` - Report progress for long operations
549
+ - `ctx.log_info(message, data)` / `ctx.log_error()` / `ctx.log_debug()` - Logging
550
+ - `ctx.elicit(prompt, input_type)` - Request input from users
551
+ - `ctx.fastmcp.name` - Access server configuration
552
+ - `ctx.read_resource(uri)` - Read MCP resources
553
+
554
+ ### Resource Registration
555
+
556
+ Expose data as resources for efficient, template-based access:
557
+
558
+ ```python
559
+ @mcp.resource("file://documents/{name}")
560
+ async def get_document(name: str) -> str:
561
+ '''Expose documents as MCP resources.
562
+
563
+ Resources are useful for static or semi-static data that doesn't
564
+ require complex parameters. They use URI templates for flexible access.
565
+ '''
566
+ document_path = f"./docs/{name}"
567
+ with open(document_path, "r") as f:
568
+ return f.read()
569
+
570
+ @mcp.resource("config://settings/{key}")
571
+ async def get_setting(key: str, ctx: Context) -> str:
572
+ '''Expose configuration as resources with context.'''
573
+ settings = await load_settings()
574
+ return json.dumps(settings.get(key, {}))
575
+ ```
576
+
577
+ **When to use Resources vs Tools:**
578
+ - **Resources**: For data access with simple parameters (URI templates)
579
+ - **Tools**: For complex operations with validation and business logic
580
+
581
+ ### Structured Output Types
582
+
583
+ FastMCP supports multiple return types beyond strings:
584
+
585
+ ```python
586
+ from typing import TypedDict
587
+ from dataclasses import dataclass
588
+ from pydantic import BaseModel
589
+
590
+ # TypedDict for structured returns
591
+ class UserData(TypedDict):
592
+ id: str
593
+ name: str
594
+ email: str
595
+
596
+ @mcp.tool()
597
+ async def get_user_typed(user_id: str) -> UserData:
598
+ '''Returns structured data - FastMCP handles serialization.'''
599
+ return {"id": user_id, "name": "John Doe", "email": "john@example.com"}
600
+
601
+ # Pydantic models for complex validation
602
+ class DetailedUser(BaseModel):
603
+ id: str
604
+ name: str
605
+ email: str
606
+ created_at: datetime
607
+ metadata: Dict[str, Any]
608
+
609
+ @mcp.tool()
610
+ async def get_user_detailed(user_id: str) -> DetailedUser:
611
+ '''Returns Pydantic model - automatically generates schema.'''
612
+ user = await fetch_user(user_id)
613
+ return DetailedUser(**user)
614
+ ```
615
+
616
+ ### Lifespan Management
617
+
618
+ Initialize resources that persist across requests:
619
+
620
+ ```python
621
+ from contextlib import asynccontextmanager
622
+
623
+ @asynccontextmanager
624
+ async def app_lifespan():
625
+ '''Manage resources that live for the server's lifetime.'''
626
+ # Initialize connections, load config, etc.
627
+ db = await connect_to_database()
628
+ config = load_configuration()
629
+
630
+ # Make available to all tools
631
+ yield {"db": db, "config": config}
632
+
633
+ # Cleanup on shutdown
634
+ await db.close()
635
+
636
+ mcp = FastMCP("example_mcp", lifespan=app_lifespan)
637
+
638
+ @mcp.tool()
639
+ async def query_data(query: str, ctx: Context) -> str:
640
+ '''Access lifespan resources through context.'''
641
+ db = ctx.request_context.lifespan_state["db"]
642
+ results = await db.query(query)
643
+ return format_results(results)
644
+ ```
645
+
646
+ ### Multiple Transport Options
647
+
648
+ FastMCP supports different transport mechanisms:
649
+
650
+ ```python
651
+ # Default: Stdio transport (for CLI tools)
652
+ if __name__ == "__main__":
653
+ mcp.run()
654
+
655
+ # HTTP transport (for web services)
656
+ if __name__ == "__main__":
657
+ mcp.run(transport="streamable_http", port=8000)
658
+
659
+ # SSE transport (for real-time updates)
660
+ if __name__ == "__main__":
661
+ mcp.run(transport="sse", port=8000)
662
+ ```
663
+
664
+ **Transport selection:**
665
+ - **Stdio**: Command-line tools, subprocess integration
666
+ - **HTTP**: Web services, remote access, multiple clients
667
+ - **SSE**: Real-time updates, push notifications
668
+
669
+ ---
670
+
671
+ ## Code Best Practices
672
+
673
+ ### Code Composability and Reusability
674
+
675
+ Your implementation MUST prioritize composability and code reuse:
676
+
677
+ 1. **Extract Common Functionality**:
678
+ - Create reusable helper functions for operations used across multiple tools
679
+ - Build shared API clients for HTTP requests instead of duplicating code
680
+ - Centralize error handling logic in utility functions
681
+ - Extract business logic into dedicated functions that can be composed
682
+ - Extract shared markdown or JSON field selection & formatting functionality
683
+
684
+ 2. **Avoid Duplication**:
685
+ - NEVER copy-paste similar code between tools
686
+ - If you find yourself writing similar logic twice, extract it into a function
687
+ - Common operations like pagination, filtering, field selection, and formatting should be shared
688
+ - Authentication/authorization logic should be centralized
689
+
690
+ ### Python-Specific Best Practices
691
+
692
+ 1. **Use Type Hints**: Always include type annotations for function parameters and return values
693
+ 2. **Pydantic Models**: Define clear Pydantic models for all input validation
694
+ 3. **Avoid Manual Validation**: Let Pydantic handle input validation with constraints
695
+ 4. **Proper Imports**: Group imports (standard library, third-party, local)
696
+ 5. **Error Handling**: Use specific exception types (httpx.HTTPStatusError, not generic Exception)
697
+ 6. **Async Context Managers**: Use `async with` for resources that need cleanup
698
+ 7. **Constants**: Define module-level constants in UPPER_CASE
699
+
700
+ ## Quality Checklist
701
+
702
+ Before finalizing your Python MCP server implementation, ensure:
703
+
704
+ ### Strategic Design
705
+ - [ ] Tools enable complete workflows, not just API endpoint wrappers
706
+ - [ ] Tool names reflect natural task subdivisions
707
+ - [ ] Response formats optimize for agent context efficiency
708
+ - [ ] Human-readable identifiers used where appropriate
709
+ - [ ] Error messages guide agents toward correct usage
710
+
711
+ ### Implementation Quality
712
+ - [ ] FOCUSED IMPLEMENTATION: Most important and valuable tools implemented
713
+ - [ ] All tools have descriptive names and documentation
714
+ - [ ] Return types are consistent across similar operations
715
+ - [ ] Error handling is implemented for all external calls
716
+ - [ ] Server name follows format: `{service}_mcp`
717
+ - [ ] All network operations use async/await
718
+ - [ ] Common functionality is extracted into reusable functions
719
+ - [ ] Error messages are clear, actionable, and educational
720
+ - [ ] Outputs are properly validated and formatted
721
+
722
+ ### Tool Configuration
723
+ - [ ] All tools implement 'name' and 'annotations' in the decorator
724
+ - [ ] Annotations correctly set (readOnlyHint, destructiveHint, idempotentHint, openWorldHint)
725
+ - [ ] All tools use Pydantic BaseModel for input validation with Field() definitions
726
+ - [ ] All Pydantic Fields have explicit types and descriptions with constraints
727
+ - [ ] All tools have comprehensive docstrings with explicit input/output types
728
+ - [ ] Docstrings include complete schema structure for dict/JSON returns
729
+ - [ ] Pydantic models handle input validation (no manual validation needed)
730
+
731
+ ### Advanced Features (where applicable)
732
+ - [ ] Context injection used for logging, progress, or elicitation
733
+ - [ ] Resources registered for appropriate data endpoints
734
+ - [ ] Lifespan management implemented for persistent connections
735
+ - [ ] Structured output types used (TypedDict, Pydantic models)
736
+ - [ ] Appropriate transport configured (stdio, HTTP, SSE)
737
+
738
+ ### Code Quality
739
+ - [ ] File includes proper imports including Pydantic imports
740
+ - [ ] Pagination is properly implemented where applicable
741
+ - [ ] Large responses check CHARACTER_LIMIT and truncate with clear messages
742
+ - [ ] Filtering options are provided for potentially large result sets
743
+ - [ ] All async functions are properly defined with `async def`
744
+ - [ ] HTTP client usage follows async patterns with proper context managers
745
+ - [ ] Type hints are used throughout the code
746
+ - [ ] Constants are defined at module level in UPPER_CASE
747
+
748
+ ### Testing
749
+ - [ ] Server runs successfully: `python your_server.py --help`
750
+ - [ ] All imports resolve correctly
751
+ - [ ] Sample tool calls work as expected
752
752
  - [ ] Error scenarios handled gracefully