@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,915 +1,915 @@
1
- # MCP Server Development Best Practices and Guidelines
2
-
3
- ## Overview
4
-
5
- This document compiles essential best practices and guidelines for building Model Context Protocol (MCP) servers. It covers naming conventions, tool design, response formats, pagination, error handling, security, and compliance requirements.
6
-
7
- ---
8
-
9
- ## Quick Reference
10
-
11
- ### Server Naming
12
- - **Python**: `{service}_mcp` (e.g., `slack_mcp`)
13
- - **Node/TypeScript**: `{service}-mcp-server` (e.g., `slack-mcp-server`)
14
-
15
- ### Tool Naming
16
- - Use snake_case with service prefix
17
- - Format: `{service}_{action}_{resource}`
18
- - Example: `slack_send_message`, `github_create_issue`
19
-
20
- ### Response Formats
21
- - Support both JSON and Markdown formats
22
- - JSON for programmatic processing
23
- - Markdown for human readability
24
-
25
- ### Pagination
26
- - Always respect `limit` parameter
27
- - Return `has_more`, `next_offset`, `total_count`
28
- - Default to 20-50 items
29
-
30
- ### Character Limits
31
- - Set CHARACTER_LIMIT constant (typically 25,000)
32
- - Truncate gracefully with clear messages
33
- - Provide guidance on filtering
34
-
35
- ---
36
-
37
- ## Table of Contents
38
- 1. Server Naming Conventions
39
- 2. Tool Naming and Design
40
- 3. Response Format Guidelines
41
- 4. Pagination Best Practices
42
- 5. Character Limits and Truncation
43
- 6. Tool Development Best Practices
44
- 7. Transport Best Practices
45
- 8. Testing Requirements
46
- 9. OAuth and Security Best Practices
47
- 10. Resource Management Best Practices
48
- 11. Prompt Management Best Practices
49
- 12. Error Handling Standards
50
- 13. Documentation Requirements
51
- 14. Compliance and Monitoring
52
-
53
- ---
54
-
55
- ## 1. Server Naming Conventions
56
-
57
- Follow these standardized naming patterns for MCP servers:
58
-
59
- **Python**: Use format `{service}_mcp` (lowercase with underscores)
60
- - Examples: `slack_mcp`, `github_mcp`, `jira_mcp`, `stripe_mcp`
61
-
62
- **Node/TypeScript**: Use format `{service}-mcp-server` (lowercase with hyphens)
63
- - Examples: `slack-mcp-server`, `github-mcp-server`, `jira-mcp-server`
64
-
65
- The name should be:
66
- - General (not tied to specific features)
67
- - Descriptive of the service/API being integrated
68
- - Easy to infer from the task description
69
- - Without version numbers or dates
70
-
71
- ---
72
-
73
- ## 2. Tool Naming and Design
74
-
75
- ### Tool Naming Best Practices
76
-
77
- 1. **Use snake_case**: `search_users`, `create_project`, `get_channel_info`
78
- 2. **Include service prefix**: Anticipate that your MCP server may be used alongside other MCP servers
79
- - Use `slack_send_message` instead of just `send_message`
80
- - Use `github_create_issue` instead of just `create_issue`
81
- - Use `asana_list_tasks` instead of just `list_tasks`
82
- 3. **Be action-oriented**: Start with verbs (get, list, search, create, etc.)
83
- 4. **Be specific**: Avoid generic names that could conflict with other servers
84
- 5. **Maintain consistency**: Use consistent naming patterns within your server
85
-
86
- ### Tool Design Guidelines
87
-
88
- - Tool descriptions must narrowly and unambiguously describe functionality
89
- - Descriptions must precisely match actual functionality
90
- - Should not create confusion with other MCP servers
91
- - Should provide tool annotations (readOnlyHint, destructiveHint, idempotentHint, openWorldHint)
92
- - Keep tool operations focused and atomic
93
-
94
- ---
95
-
96
- ## 3. Response Format Guidelines
97
-
98
- All tools that return data should support multiple formats for flexibility:
99
-
100
- ### JSON Format (`response_format="json"`)
101
- - Machine-readable structured data
102
- - Include all available fields and metadata
103
- - Consistent field names and types
104
- - Suitable for programmatic processing
105
- - Use for when LLMs need to process data further
106
-
107
- ### Markdown Format (`response_format="markdown"`, typically default)
108
- - Human-readable formatted text
109
- - Use headers, lists, and formatting for clarity
110
- - Convert timestamps to human-readable format (e.g., "2024-01-15 10:30:00 UTC" instead of epoch)
111
- - Show display names with IDs in parentheses (e.g., "@john.doe (U123456)")
112
- - Omit verbose metadata (e.g., show only one profile image URL, not all sizes)
113
- - Group related information logically
114
- - Use for when presenting information to users
115
-
116
- ---
117
-
118
- ## 4. Pagination Best Practices
119
-
120
- For tools that list resources:
121
-
122
- - **Always respect the `limit` parameter**: Never load all results when a limit is specified
123
- - **Implement pagination**: Use `offset` or cursor-based pagination
124
- - **Return pagination metadata**: Include `has_more`, `next_offset`/`next_cursor`, `total_count`
125
- - **Never load all results into memory**: Especially important for large datasets
126
- - **Default to reasonable limits**: 20-50 items is typical
127
- - **Include clear pagination info in responses**: Make it easy for LLMs to request more data
128
-
129
- Example pagination response structure:
130
- ```json
131
- {
132
- "total": 150,
133
- "count": 20,
134
- "offset": 0,
135
- "items": [...],
136
- "has_more": true,
137
- "next_offset": 20
138
- }
139
- ```
140
-
141
- ---
142
-
143
- ## 5. Character Limits and Truncation
144
-
145
- To prevent overwhelming responses with too much data:
146
-
147
- - **Define CHARACTER_LIMIT constant**: Typically 25,000 characters at module level
148
- - **Check response size before returning**: Measure the final response length
149
- - **Truncate gracefully with clear indicators**: Let the LLM know data was truncated
150
- - **Provide guidance on filtering**: Suggest how to use parameters to reduce results
151
- - **Include truncation metadata**: Show what was truncated and how to get more
152
-
153
- Example truncation handling:
154
- ```python
155
- CHARACTER_LIMIT = 25000
156
-
157
- if len(result) > CHARACTER_LIMIT:
158
- truncated_data = data[:max(1, len(data) // 2)]
159
- response["truncated"] = True
160
- response["truncation_message"] = (
161
- f"Response truncated from {len(data)} to {len(truncated_data)} items. "
162
- f"Use 'offset' parameter or add filters to see more results."
163
- )
164
- ```
165
-
166
- ---
167
-
168
- ## 6. Transport Options
169
-
170
- MCP servers support multiple transport mechanisms for different deployment scenarios:
171
-
172
- ### Stdio Transport
173
-
174
- **Best for**: Command-line tools, local integrations, subprocess execution
175
-
176
- **Characteristics**:
177
- - Standard input/output stream communication
178
- - Simple setup, no network configuration needed
179
- - Runs as a subprocess of the client
180
- - Ideal for desktop applications and CLI tools
181
-
182
- **Use when**:
183
- - Building tools for local development environments
184
- - Integrating with desktop applications (e.g., Claude Desktop)
185
- - Creating command-line utilities
186
- - Single-user, single-session scenarios
187
-
188
- ### HTTP Transport
189
-
190
- **Best for**: Web services, remote access, multi-client scenarios
191
-
192
- **Characteristics**:
193
- - Request-response pattern over HTTP
194
- - Supports multiple simultaneous clients
195
- - Can be deployed as a web service
196
- - Requires network configuration and security considerations
197
-
198
- **Use when**:
199
- - Serving multiple clients simultaneously
200
- - Deploying as a cloud service
201
- - Integration with web applications
202
- - Need for load balancing or scaling
203
-
204
- ### Server-Sent Events (SSE) Transport
205
-
206
- **Best for**: Real-time updates, push notifications, streaming data
207
-
208
- **Characteristics**:
209
- - One-way server-to-client streaming over HTTP
210
- - Enables real-time updates without polling
211
- - Long-lived connections for continuous data flow
212
- - Built on standard HTTP infrastructure
213
-
214
- **Use when**:
215
- - Clients need real-time data updates
216
- - Implementing push notifications
217
- - Streaming logs or monitoring data
218
- - Progressive result delivery for long operations
219
-
220
- ### Transport Selection Criteria
221
-
222
- | Criterion | Stdio | HTTP | SSE |
223
- |-----------|-------|------|-----|
224
- | **Deployment** | Local | Remote | Remote |
225
- | **Clients** | Single | Multiple | Multiple |
226
- | **Communication** | Bidirectional | Request-Response | Server-Push |
227
- | **Complexity** | Low | Medium | Medium-High |
228
- | **Real-time** | No | No | Yes |
229
-
230
- ---
231
-
232
- ## 7. Tool Development Best Practices
233
-
234
- ### General Guidelines
235
- 1. Tool names should be descriptive and action-oriented
236
- 2. Use parameter validation with detailed JSON schemas
237
- 3. Include examples in tool descriptions
238
- 4. Implement proper error handling and validation
239
- 5. Use progress reporting for long operations
240
- 6. Keep tool operations focused and atomic
241
- 7. Document expected return value structures
242
- 8. Implement proper timeouts
243
- 9. Consider rate limiting for resource-intensive operations
244
- 10. Log tool usage for debugging and monitoring
245
-
246
- ### Security Considerations for Tools
247
-
248
- #### Input Validation
249
- - Validate all parameters against schema
250
- - Sanitize file paths and system commands
251
- - Validate URLs and external identifiers
252
- - Check parameter sizes and ranges
253
- - Prevent command injection
254
-
255
- #### Access Control
256
- - Implement authentication where needed
257
- - Use appropriate authorization checks
258
- - Audit tool usage
259
- - Rate limit requests
260
- - Monitor for abuse
261
-
262
- #### Error Handling
263
- - Don't expose internal errors to clients
264
- - Log security-relevant errors
265
- - Handle timeouts appropriately
266
- - Clean up resources after errors
267
- - Validate return values
268
-
269
- ### Tool Annotations
270
- - Provide readOnlyHint and destructiveHint annotations
271
- - Remember annotations are hints, not security guarantees
272
- - Clients should not make security-critical decisions based solely on annotations
273
-
274
- ---
275
-
276
- ## 8. Transport Best Practices
277
-
278
- ### General Transport Guidelines
279
- 1. Handle connection lifecycle properly
280
- 2. Implement proper error handling
281
- 3. Use appropriate timeout values
282
- 4. Implement connection state management
283
- 5. Clean up resources on disconnection
284
-
285
- ### Security Best Practices for Transport
286
- - Follow security considerations for DNS rebinding attacks
287
- - Implement proper authentication mechanisms
288
- - Validate message formats
289
- - Handle malformed messages gracefully
290
-
291
- ### Stdio Transport Specific
292
- - Local MCP servers should NOT log to stdout (interferes with protocol)
293
- - Use stderr for logging messages
294
- - Handle standard I/O streams properly
295
-
296
- ---
297
-
298
- ## 9. Testing Requirements
299
-
300
- A comprehensive testing strategy should cover:
301
-
302
- ### Functional Testing
303
- - Verify correct execution with valid/invalid inputs
304
-
305
- ### Integration Testing
306
- - Test interaction with external systems
307
-
308
- ### Security Testing
309
- - Validate auth, input sanitization, rate limiting
310
-
311
- ### Performance Testing
312
- - Check behavior under load, timeouts
313
-
314
- ### Error Handling
315
- - Ensure proper error reporting and cleanup
316
-
317
- ---
318
-
319
- ## 10. OAuth and Security Best Practices
320
-
321
- ### Authentication and Authorization
322
-
323
- MCP servers that connect to external services should implement proper authentication:
324
-
325
- **OAuth 2.1 Implementation:**
326
- - Use secure OAuth 2.1 with certificates from recognized authorities
327
- - Validate access tokens before processing requests
328
- - Only accept tokens specifically intended for your server
329
- - Reject tokens without proper audience claims
330
- - Never pass through tokens received from MCP clients
331
-
332
- **API Key Management:**
333
- - Store API keys in environment variables, never in code
334
- - Validate keys on server startup
335
- - Provide clear error messages when authentication fails
336
- - Use secure transmission for sensitive credentials
337
-
338
- ### Input Validation and Security
339
-
340
- **Always validate inputs:**
341
- - Sanitize file paths to prevent directory traversal
342
- - Validate URLs and external identifiers
343
- - Check parameter sizes and ranges
344
- - Prevent command injection in system calls
345
- - Use schema validation (Pydantic/Zod) for all inputs
346
-
347
- **Error handling security:**
348
- - Don't expose internal errors to clients
349
- - Log security-relevant errors server-side
350
- - Provide helpful but not revealing error messages
351
- - Clean up resources after errors
352
-
353
- ### Privacy and Data Protection
354
-
355
- **Data collection principles:**
356
- - Only collect data strictly necessary for functionality
357
- - Don't collect extraneous conversation data
358
- - Don't collect PII unless explicitly required for the tool's purpose
359
- - Provide clear information about what data is accessed
360
-
361
- **Data transmission:**
362
- - Don't send data to servers outside your organization without disclosure
363
- - Use secure transmission (HTTPS) for all network communication
364
- - Validate certificates for external services
365
-
366
- ---
367
-
368
- ## 11. Resource Management Best Practices
369
-
370
- 1. Only suggest necessary resources
371
- 2. Use clear, descriptive names for roots
372
- 3. Handle resource boundaries properly
373
- 4. Respect client control over resources
374
- 5. Use model-controlled primitives (tools) for automatic data exposure
375
-
376
- ---
377
-
378
- ## 12. Prompt Management Best Practices
379
-
380
- - Clients should show users proposed prompts
381
- - Users should be able to modify or reject prompts
382
- - Clients should show users completions
383
- - Users should be able to modify or reject completions
384
- - Consider costs when using sampling
385
-
386
- ---
387
-
388
- ## 13. Error Handling Standards
389
-
390
- - Use standard JSON-RPC error codes
391
- - Report tool errors within result objects (not protocol-level)
392
- - Provide helpful, specific error messages
393
- - Don't expose internal implementation details
394
- - Clean up resources properly on errors
395
-
396
- ---
397
-
398
- ## 14. Documentation Requirements
399
-
400
- - Provide clear documentation of all tools and capabilities
401
- - Include working examples (at least 3 per major feature)
402
- - Document security considerations
403
- - Specify required permissions and access levels
404
- - Document rate limits and performance characteristics
405
-
406
- ---
407
-
408
- ## 15. Compliance and Monitoring
409
-
410
- - Implement logging for debugging and monitoring
411
- - Track tool usage patterns
412
- - Monitor for potential abuse
413
- - Maintain audit trails for security-relevant operations
414
- - Be prepared for ongoing compliance reviews
415
-
416
- ---
417
-
418
- ## Summary
419
-
420
- These best practices represent the comprehensive guidelines for building secure, efficient, and compliant MCP servers that work well within the ecosystem. Developers should follow these guidelines to ensure their MCP servers meet the standards for inclusion in the MCP directory and provide a safe, reliable experience for users.
421
-
422
-
423
- ----------
424
-
425
-
426
- # Tools
427
-
428
- > Enable LLMs to perform actions through your server
429
-
430
- Tools are a powerful primitive in the Model Context Protocol (MCP) that enable servers to expose executable functionality to clients. Through tools, LLMs can interact with external systems, perform computations, and take actions in the real world.
431
-
432
- <Note>
433
- Tools are designed to be **model-controlled**, meaning that tools are exposed from servers to clients with the intention of the AI model being able to automatically invoke them (with a human in the loop to grant approval).
434
- </Note>
435
-
436
- ## Overview
437
-
438
- Tools in MCP allow servers to expose executable functions that can be invoked by clients and used by LLMs to perform actions. Key aspects of tools include:
439
-
440
- * **Discovery**: Clients can obtain a list of available tools by sending a `tools/list` request
441
- * **Invocation**: Tools are called using the `tools/call` request, where servers perform the requested operation and return results
442
- * **Flexibility**: Tools can range from simple calculations to complex API interactions
443
-
444
- Like [resources](/docs/concepts/resources), tools are identified by unique names and can include descriptions to guide their usage. However, unlike resources, tools represent dynamic operations that can modify state or interact with external systems.
445
-
446
- ## Tool definition structure
447
-
448
- Each tool is defined with the following structure:
449
-
450
- ```typescript
451
- {
452
- name: string; // Unique identifier for the tool
453
- description?: string; // Human-readable description
454
- inputSchema: { // JSON Schema for the tool's parameters
455
- type: "object",
456
- properties: { ... } // Tool-specific parameters
457
- },
458
- annotations?: { // Optional hints about tool behavior
459
- title?: string; // Human-readable title for the tool
460
- readOnlyHint?: boolean; // If true, the tool does not modify its environment
461
- destructiveHint?: boolean; // If true, the tool may perform destructive updates
462
- idempotentHint?: boolean; // If true, repeated calls with same args have no additional effect
463
- openWorldHint?: boolean; // If true, tool interacts with external entities
464
- }
465
- }
466
- ```
467
-
468
- ## Implementing tools
469
-
470
- Here's an example of implementing a basic tool in an MCP server:
471
-
472
- <Tabs>
473
- <Tab title="TypeScript">
474
- ```typescript
475
- const server = new Server({
476
- name: "example-server",
477
- version: "1.0.0"
478
- }, {
479
- capabilities: {
480
- tools: {}
481
- }
482
- });
483
-
484
- // Define available tools
485
- server.setRequestHandler(ListToolsRequestSchema, async () => {
486
- return {
487
- tools: [{
488
- name: "calculate_sum",
489
- description: "Add two numbers together",
490
- inputSchema: {
491
- type: "object",
492
- properties: {
493
- a: { type: "number" },
494
- b: { type: "number" }
495
- },
496
- required: ["a", "b"]
497
- }
498
- }]
499
- };
500
- });
501
-
502
- // Handle tool execution
503
- server.setRequestHandler(CallToolRequestSchema, async (request) => {
504
- if (request.params.name === "calculate_sum") {
505
- const { a, b } = request.params.arguments;
506
- return {
507
- content: [
508
- {
509
- type: "text",
510
- text: String(a + b)
511
- }
512
- ]
513
- };
514
- }
515
- throw new Error("Tool not found");
516
- });
517
- ```
518
- </Tab>
519
-
520
- <Tab title="Python">
521
- ```python
522
- app = Server("example-server")
523
-
524
- @app.list_tools()
525
- async def list_tools() -> list[types.Tool]:
526
- return [
527
- types.Tool(
528
- name="calculate_sum",
529
- description="Add two numbers together",
530
- inputSchema={
531
- "type": "object",
532
- "properties": {
533
- "a": {"type": "number"},
534
- "b": {"type": "number"}
535
- },
536
- "required": ["a", "b"]
537
- }
538
- )
539
- ]
540
-
541
- @app.call_tool()
542
- async def call_tool(
543
- name: str,
544
- arguments: dict
545
- ) -> list[types.TextContent | types.ImageContent | types.EmbeddedResource]:
546
- if name == "calculate_sum":
547
- a = arguments["a"]
548
- b = arguments["b"]
549
- result = a + b
550
- return [types.TextContent(type="text", text=str(result))]
551
- raise ValueError(f"Tool not found: {name}")
552
- ```
553
- </Tab>
554
- </Tabs>
555
-
556
- ## Example tool patterns
557
-
558
- Here are some examples of types of tools that a server could provide:
559
-
560
- ### System operations
561
-
562
- Tools that interact with the local system:
563
-
564
- ```typescript
565
- {
566
- name: "execute_command",
567
- description: "Run a shell command",
568
- inputSchema: {
569
- type: "object",
570
- properties: {
571
- command: { type: "string" },
572
- args: { type: "array", items: { type: "string" } }
573
- }
574
- }
575
- }
576
- ```
577
-
578
- ### API integrations
579
-
580
- Tools that wrap external APIs:
581
-
582
- ```typescript
583
- {
584
- name: "github_create_issue",
585
- description: "Create a GitHub issue",
586
- inputSchema: {
587
- type: "object",
588
- properties: {
589
- title: { type: "string" },
590
- body: { type: "string" },
591
- labels: { type: "array", items: { type: "string" } }
592
- }
593
- }
594
- }
595
- ```
596
-
597
- ### Data processing
598
-
599
- Tools that transform or analyze data:
600
-
601
- ```typescript
602
- {
603
- name: "analyze_csv",
604
- description: "Analyze a CSV file",
605
- inputSchema: {
606
- type: "object",
607
- properties: {
608
- filepath: { type: "string" },
609
- operations: {
610
- type: "array",
611
- items: {
612
- enum: ["sum", "average", "count"]
613
- }
614
- }
615
- }
616
- }
617
- }
618
- ```
619
-
620
- ## Best practices
621
-
622
- When implementing tools:
623
-
624
- 1. Provide clear, descriptive names and descriptions
625
- 2. Use detailed JSON Schema definitions for parameters
626
- 3. Include examples in tool descriptions to demonstrate how the model should use them
627
- 4. Implement proper error handling and validation
628
- 5. Use progress reporting for long operations
629
- 6. Keep tool operations focused and atomic
630
- 7. Document expected return value structures
631
- 8. Implement proper timeouts
632
- 9. Consider rate limiting for resource-intensive operations
633
- 10. Log tool usage for debugging and monitoring
634
-
635
- ### Tool name conflicts
636
-
637
- MCP client applications and MCP server proxies may encounter tool name conflicts when building their own tool lists. For example, two connected MCP servers `web1` and `web2` may both expose a tool named `search_web`.
638
-
639
- Applications may disambiguiate tools with one of the following strategies (among others; not an exhaustive list):
640
-
641
- * Concatenating a unique, user-defined server name with the tool name, e.g. `web1___search_web` and `web2___search_web`. This strategy may be preferable when unique server names are already provided by the user in a configuration file.
642
- * Generating a random prefix for the tool name, e.g. `jrwxs___search_web` and `6cq52___search_web`. This strategy may be preferable in server proxies where user-defined unique names are not available.
643
- * Using the server URI as a prefix for the tool name, e.g. `web1.example.com:search_web` and `web2.example.com:search_web`. This strategy may be suitable when working with remote MCP servers.
644
-
645
- Note that the server-provided name from the initialization flow is not guaranteed to be unique and is not generally suitable for disambiguation purposes.
646
-
647
- ## Security considerations
648
-
649
- When exposing tools:
650
-
651
- ### Input validation
652
-
653
- * Validate all parameters against the schema
654
- * Sanitize file paths and system commands
655
- * Validate URLs and external identifiers
656
- * Check parameter sizes and ranges
657
- * Prevent command injection
658
-
659
- ### Access control
660
-
661
- * Implement authentication where needed
662
- * Use appropriate authorization checks
663
- * Audit tool usage
664
- * Rate limit requests
665
- * Monitor for abuse
666
-
667
- ### Error handling
668
-
669
- * Don't expose internal errors to clients
670
- * Log security-relevant errors
671
- * Handle timeouts appropriately
672
- * Clean up resources after errors
673
- * Validate return values
674
-
675
- ## Tool discovery and updates
676
-
677
- MCP supports dynamic tool discovery:
678
-
679
- 1. Clients can list available tools at any time
680
- 2. Servers can notify clients when tools change using `notifications/tools/list_changed`
681
- 3. Tools can be added or removed during runtime
682
- 4. Tool definitions can be updated (though this should be done carefully)
683
-
684
- ## Error handling
685
-
686
- Tool errors should be reported within the result object, not as MCP protocol-level errors. This allows the LLM to see and potentially handle the error. When a tool encounters an error:
687
-
688
- 1. Set `isError` to `true` in the result
689
- 2. Include error details in the `content` array
690
-
691
- Here's an example of proper error handling for tools:
692
-
693
- <Tabs>
694
- <Tab title="TypeScript">
695
- ```typescript
696
- try {
697
- // Tool operation
698
- const result = performOperation();
699
- return {
700
- content: [
701
- {
702
- type: "text",
703
- text: `Operation successful: ${result}`
704
- }
705
- ]
706
- };
707
- } catch (error) {
708
- return {
709
- isError: true,
710
- content: [
711
- {
712
- type: "text",
713
- text: `Error: ${error.message}`
714
- }
715
- ]
716
- };
717
- }
718
- ```
719
- </Tab>
720
-
721
- <Tab title="Python">
722
- ```python
723
- try:
724
- # Tool operation
725
- result = perform_operation()
726
- return types.CallToolResult(
727
- content=[
728
- types.TextContent(
729
- type="text",
730
- text=f"Operation successful: {result}"
731
- )
732
- ]
733
- )
734
- except Exception as error:
735
- return types.CallToolResult(
736
- isError=True,
737
- content=[
738
- types.TextContent(
739
- type="text",
740
- text=f"Error: {str(error)}"
741
- )
742
- ]
743
- )
744
- ```
745
- </Tab>
746
- </Tabs>
747
-
748
- This approach allows the LLM to see that an error occurred and potentially take corrective action or request human intervention.
749
-
750
- ## Tool annotations
751
-
752
- Tool annotations provide additional metadata about a tool's behavior, helping clients understand how to present and manage tools. These annotations are hints that describe the nature and impact of a tool, but should not be relied upon for security decisions.
753
-
754
- ### Purpose of tool annotations
755
-
756
- Tool annotations serve several key purposes:
757
-
758
- 1. Provide UX-specific information without affecting model context
759
- 2. Help clients categorize and present tools appropriately
760
- 3. Convey information about a tool's potential side effects
761
- 4. Assist in developing intuitive interfaces for tool approval
762
-
763
- ### Available tool annotations
764
-
765
- The MCP specification defines the following annotations for tools:
766
-
767
- | Annotation | Type | Default | Description |
768
- | ----------------- | ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ |
769
- | `title` | string | - | A human-readable title for the tool, useful for UI display |
770
- | `readOnlyHint` | boolean | false | If true, indicates the tool does not modify its environment |
771
- | `destructiveHint` | boolean | true | If true, the tool may perform destructive updates (only meaningful when `readOnlyHint` is false) |
772
- | `idempotentHint` | boolean | false | If true, calling the tool repeatedly with the same arguments has no additional effect (only meaningful when `readOnlyHint` is false) |
773
- | `openWorldHint` | boolean | true | If true, the tool may interact with an "open world" of external entities |
774
-
775
- ### Example usage
776
-
777
- Here's how to define tools with annotations for different scenarios:
778
-
779
- ```typescript
780
- // A read-only search tool
781
- {
782
- name: "web_search",
783
- description: "Search the web for information",
784
- inputSchema: {
785
- type: "object",
786
- properties: {
787
- query: { type: "string" }
788
- },
789
- required: ["query"]
790
- },
791
- annotations: {
792
- title: "Web Search",
793
- readOnlyHint: true,
794
- openWorldHint: true
795
- }
796
- }
797
-
798
- // A destructive file deletion tool
799
- {
800
- name: "delete_file",
801
- description: "Delete a file from the filesystem",
802
- inputSchema: {
803
- type: "object",
804
- properties: {
805
- path: { type: "string" }
806
- },
807
- required: ["path"]
808
- },
809
- annotations: {
810
- title: "Delete File",
811
- readOnlyHint: false,
812
- destructiveHint: true,
813
- idempotentHint: true,
814
- openWorldHint: false
815
- }
816
- }
817
-
818
- // A non-destructive database record creation tool
819
- {
820
- name: "create_record",
821
- description: "Create a new record in the database",
822
- inputSchema: {
823
- type: "object",
824
- properties: {
825
- table: { type: "string" },
826
- data: { type: "object" }
827
- },
828
- required: ["table", "data"]
829
- },
830
- annotations: {
831
- title: "Create Database Record",
832
- readOnlyHint: false,
833
- destructiveHint: false,
834
- idempotentHint: false,
835
- openWorldHint: false
836
- }
837
- }
838
- ```
839
-
840
- ### Integrating annotations in server implementation
841
-
842
- <Tabs>
843
- <Tab title="TypeScript">
844
- ```typescript
845
- server.setRequestHandler(ListToolsRequestSchema, async () => {
846
- return {
847
- tools: [{
848
- name: "calculate_sum",
849
- description: "Add two numbers together",
850
- inputSchema: {
851
- type: "object",
852
- properties: {
853
- a: { type: "number" },
854
- b: { type: "number" }
855
- },
856
- required: ["a", "b"]
857
- },
858
- annotations: {
859
- title: "Calculate Sum",
860
- readOnlyHint: true,
861
- openWorldHint: false
862
- }
863
- }]
864
- };
865
- });
866
- ```
867
- </Tab>
868
-
869
- <Tab title="Python">
870
- ```python
871
- from mcp.server.fastmcp import FastMCP
872
-
873
- mcp = FastMCP("example-server")
874
-
875
- @mcp.tool(
876
- annotations={
877
- "title": "Calculate Sum",
878
- "readOnlyHint": True,
879
- "openWorldHint": False
880
- }
881
- )
882
- async def calculate_sum(a: float, b: float) -> str:
883
- """Add two numbers together.
884
-
885
- Args:
886
- a: First number to add
887
- b: Second number to add
888
- """
889
- result = a + b
890
- return str(result)
891
- ```
892
- </Tab>
893
- </Tabs>
894
-
895
- ### Best practices for tool annotations
896
-
897
- 1. **Be accurate about side effects**: Clearly indicate whether a tool modifies its environment and whether those modifications are destructive.
898
-
899
- 2. **Use descriptive titles**: Provide human-friendly titles that clearly describe the tool's purpose.
900
-
901
- 3. **Indicate idempotency properly**: Mark tools as idempotent only if repeated calls with the same arguments truly have no additional effect.
902
-
903
- 4. **Set appropriate open/closed world hints**: Indicate whether a tool interacts with a closed system (like a database) or an open system (like the web).
904
-
905
- 5. **Remember annotations are hints**: All properties in ToolAnnotations are hints and not guaranteed to provide a faithful description of tool behavior. Clients should never make security-critical decisions based solely on annotations.
906
-
907
- ## Testing tools
908
-
909
- A comprehensive testing strategy for MCP tools should cover:
910
-
911
- * **Functional testing**: Verify tools execute correctly with valid inputs and handle invalid inputs appropriately
912
- * **Integration testing**: Test tool interaction with external systems using both real and mocked dependencies
913
- * **Security testing**: Validate authentication, authorization, input sanitization, and rate limiting
914
- * **Performance testing**: Check behavior under load, timeout handling, and resource cleanup
915
- * **Error handling**: Ensure tools properly report errors through the MCP protocol and clean up resources
1
+ # MCP Server Development Best Practices and Guidelines
2
+
3
+ ## Overview
4
+
5
+ This document compiles essential best practices and guidelines for building Model Context Protocol (MCP) servers. It covers naming conventions, tool design, response formats, pagination, error handling, security, and compliance requirements.
6
+
7
+ ---
8
+
9
+ ## Quick Reference
10
+
11
+ ### Server Naming
12
+ - **Python**: `{service}_mcp` (e.g., `slack_mcp`)
13
+ - **Node/TypeScript**: `{service}-mcp-server` (e.g., `slack-mcp-server`)
14
+
15
+ ### Tool Naming
16
+ - Use snake_case with service prefix
17
+ - Format: `{service}_{action}_{resource}`
18
+ - Example: `slack_send_message`, `github_create_issue`
19
+
20
+ ### Response Formats
21
+ - Support both JSON and Markdown formats
22
+ - JSON for programmatic processing
23
+ - Markdown for human readability
24
+
25
+ ### Pagination
26
+ - Always respect `limit` parameter
27
+ - Return `has_more`, `next_offset`, `total_count`
28
+ - Default to 20-50 items
29
+
30
+ ### Character Limits
31
+ - Set CHARACTER_LIMIT constant (typically 25,000)
32
+ - Truncate gracefully with clear messages
33
+ - Provide guidance on filtering
34
+
35
+ ---
36
+
37
+ ## Table of Contents
38
+ 1. Server Naming Conventions
39
+ 2. Tool Naming and Design
40
+ 3. Response Format Guidelines
41
+ 4. Pagination Best Practices
42
+ 5. Character Limits and Truncation
43
+ 6. Tool Development Best Practices
44
+ 7. Transport Best Practices
45
+ 8. Testing Requirements
46
+ 9. OAuth and Security Best Practices
47
+ 10. Resource Management Best Practices
48
+ 11. Prompt Management Best Practices
49
+ 12. Error Handling Standards
50
+ 13. Documentation Requirements
51
+ 14. Compliance and Monitoring
52
+
53
+ ---
54
+
55
+ ## 1. Server Naming Conventions
56
+
57
+ Follow these standardized naming patterns for MCP servers:
58
+
59
+ **Python**: Use format `{service}_mcp` (lowercase with underscores)
60
+ - Examples: `slack_mcp`, `github_mcp`, `jira_mcp`, `stripe_mcp`
61
+
62
+ **Node/TypeScript**: Use format `{service}-mcp-server` (lowercase with hyphens)
63
+ - Examples: `slack-mcp-server`, `github-mcp-server`, `jira-mcp-server`
64
+
65
+ The name should be:
66
+ - General (not tied to specific features)
67
+ - Descriptive of the service/API being integrated
68
+ - Easy to infer from the task description
69
+ - Without version numbers or dates
70
+
71
+ ---
72
+
73
+ ## 2. Tool Naming and Design
74
+
75
+ ### Tool Naming Best Practices
76
+
77
+ 1. **Use snake_case**: `search_users`, `create_project`, `get_channel_info`
78
+ 2. **Include service prefix**: Anticipate that your MCP server may be used alongside other MCP servers
79
+ - Use `slack_send_message` instead of just `send_message`
80
+ - Use `github_create_issue` instead of just `create_issue`
81
+ - Use `asana_list_tasks` instead of just `list_tasks`
82
+ 3. **Be action-oriented**: Start with verbs (get, list, search, create, etc.)
83
+ 4. **Be specific**: Avoid generic names that could conflict with other servers
84
+ 5. **Maintain consistency**: Use consistent naming patterns within your server
85
+
86
+ ### Tool Design Guidelines
87
+
88
+ - Tool descriptions must narrowly and unambiguously describe functionality
89
+ - Descriptions must precisely match actual functionality
90
+ - Should not create confusion with other MCP servers
91
+ - Should provide tool annotations (readOnlyHint, destructiveHint, idempotentHint, openWorldHint)
92
+ - Keep tool operations focused and atomic
93
+
94
+ ---
95
+
96
+ ## 3. Response Format Guidelines
97
+
98
+ All tools that return data should support multiple formats for flexibility:
99
+
100
+ ### JSON Format (`response_format="json"`)
101
+ - Machine-readable structured data
102
+ - Include all available fields and metadata
103
+ - Consistent field names and types
104
+ - Suitable for programmatic processing
105
+ - Use for when LLMs need to process data further
106
+
107
+ ### Markdown Format (`response_format="markdown"`, typically default)
108
+ - Human-readable formatted text
109
+ - Use headers, lists, and formatting for clarity
110
+ - Convert timestamps to human-readable format (e.g., "2024-01-15 10:30:00 UTC" instead of epoch)
111
+ - Show display names with IDs in parentheses (e.g., "@john.doe (U123456)")
112
+ - Omit verbose metadata (e.g., show only one profile image URL, not all sizes)
113
+ - Group related information logically
114
+ - Use for when presenting information to users
115
+
116
+ ---
117
+
118
+ ## 4. Pagination Best Practices
119
+
120
+ For tools that list resources:
121
+
122
+ - **Always respect the `limit` parameter**: Never load all results when a limit is specified
123
+ - **Implement pagination**: Use `offset` or cursor-based pagination
124
+ - **Return pagination metadata**: Include `has_more`, `next_offset`/`next_cursor`, `total_count`
125
+ - **Never load all results into memory**: Especially important for large datasets
126
+ - **Default to reasonable limits**: 20-50 items is typical
127
+ - **Include clear pagination info in responses**: Make it easy for LLMs to request more data
128
+
129
+ Example pagination response structure:
130
+ ```json
131
+ {
132
+ "total": 150,
133
+ "count": 20,
134
+ "offset": 0,
135
+ "items": [...],
136
+ "has_more": true,
137
+ "next_offset": 20
138
+ }
139
+ ```
140
+
141
+ ---
142
+
143
+ ## 5. Character Limits and Truncation
144
+
145
+ To prevent overwhelming responses with too much data:
146
+
147
+ - **Define CHARACTER_LIMIT constant**: Typically 25,000 characters at module level
148
+ - **Check response size before returning**: Measure the final response length
149
+ - **Truncate gracefully with clear indicators**: Let the LLM know data was truncated
150
+ - **Provide guidance on filtering**: Suggest how to use parameters to reduce results
151
+ - **Include truncation metadata**: Show what was truncated and how to get more
152
+
153
+ Example truncation handling:
154
+ ```python
155
+ CHARACTER_LIMIT = 25000
156
+
157
+ if len(result) > CHARACTER_LIMIT:
158
+ truncated_data = data[:max(1, len(data) // 2)]
159
+ response["truncated"] = True
160
+ response["truncation_message"] = (
161
+ f"Response truncated from {len(data)} to {len(truncated_data)} items. "
162
+ f"Use 'offset' parameter or add filters to see more results."
163
+ )
164
+ ```
165
+
166
+ ---
167
+
168
+ ## 6. Transport Options
169
+
170
+ MCP servers support multiple transport mechanisms for different deployment scenarios:
171
+
172
+ ### Stdio Transport
173
+
174
+ **Best for**: Command-line tools, local integrations, subprocess execution
175
+
176
+ **Characteristics**:
177
+ - Standard input/output stream communication
178
+ - Simple setup, no network configuration needed
179
+ - Runs as a subprocess of the client
180
+ - Ideal for desktop applications and CLI tools
181
+
182
+ **Use when**:
183
+ - Building tools for local development environments
184
+ - Integrating with desktop applications (e.g., Claude Desktop)
185
+ - Creating command-line utilities
186
+ - Single-user, single-session scenarios
187
+
188
+ ### HTTP Transport
189
+
190
+ **Best for**: Web services, remote access, multi-client scenarios
191
+
192
+ **Characteristics**:
193
+ - Request-response pattern over HTTP
194
+ - Supports multiple simultaneous clients
195
+ - Can be deployed as a web service
196
+ - Requires network configuration and security considerations
197
+
198
+ **Use when**:
199
+ - Serving multiple clients simultaneously
200
+ - Deploying as a cloud service
201
+ - Integration with web applications
202
+ - Need for load balancing or scaling
203
+
204
+ ### Server-Sent Events (SSE) Transport
205
+
206
+ **Best for**: Real-time updates, push notifications, streaming data
207
+
208
+ **Characteristics**:
209
+ - One-way server-to-client streaming over HTTP
210
+ - Enables real-time updates without polling
211
+ - Long-lived connections for continuous data flow
212
+ - Built on standard HTTP infrastructure
213
+
214
+ **Use when**:
215
+ - Clients need real-time data updates
216
+ - Implementing push notifications
217
+ - Streaming logs or monitoring data
218
+ - Progressive result delivery for long operations
219
+
220
+ ### Transport Selection Criteria
221
+
222
+ | Criterion | Stdio | HTTP | SSE |
223
+ |-----------|-------|------|-----|
224
+ | **Deployment** | Local | Remote | Remote |
225
+ | **Clients** | Single | Multiple | Multiple |
226
+ | **Communication** | Bidirectional | Request-Response | Server-Push |
227
+ | **Complexity** | Low | Medium | Medium-High |
228
+ | **Real-time** | No | No | Yes |
229
+
230
+ ---
231
+
232
+ ## 7. Tool Development Best Practices
233
+
234
+ ### General Guidelines
235
+ 1. Tool names should be descriptive and action-oriented
236
+ 2. Use parameter validation with detailed JSON schemas
237
+ 3. Include examples in tool descriptions
238
+ 4. Implement proper error handling and validation
239
+ 5. Use progress reporting for long operations
240
+ 6. Keep tool operations focused and atomic
241
+ 7. Document expected return value structures
242
+ 8. Implement proper timeouts
243
+ 9. Consider rate limiting for resource-intensive operations
244
+ 10. Log tool usage for debugging and monitoring
245
+
246
+ ### Security Considerations for Tools
247
+
248
+ #### Input Validation
249
+ - Validate all parameters against schema
250
+ - Sanitize file paths and system commands
251
+ - Validate URLs and external identifiers
252
+ - Check parameter sizes and ranges
253
+ - Prevent command injection
254
+
255
+ #### Access Control
256
+ - Implement authentication where needed
257
+ - Use appropriate authorization checks
258
+ - Audit tool usage
259
+ - Rate limit requests
260
+ - Monitor for abuse
261
+
262
+ #### Error Handling
263
+ - Don't expose internal errors to clients
264
+ - Log security-relevant errors
265
+ - Handle timeouts appropriately
266
+ - Clean up resources after errors
267
+ - Validate return values
268
+
269
+ ### Tool Annotations
270
+ - Provide readOnlyHint and destructiveHint annotations
271
+ - Remember annotations are hints, not security guarantees
272
+ - Clients should not make security-critical decisions based solely on annotations
273
+
274
+ ---
275
+
276
+ ## 8. Transport Best Practices
277
+
278
+ ### General Transport Guidelines
279
+ 1. Handle connection lifecycle properly
280
+ 2. Implement proper error handling
281
+ 3. Use appropriate timeout values
282
+ 4. Implement connection state management
283
+ 5. Clean up resources on disconnection
284
+
285
+ ### Security Best Practices for Transport
286
+ - Follow security considerations for DNS rebinding attacks
287
+ - Implement proper authentication mechanisms
288
+ - Validate message formats
289
+ - Handle malformed messages gracefully
290
+
291
+ ### Stdio Transport Specific
292
+ - Local MCP servers should NOT log to stdout (interferes with protocol)
293
+ - Use stderr for logging messages
294
+ - Handle standard I/O streams properly
295
+
296
+ ---
297
+
298
+ ## 9. Testing Requirements
299
+
300
+ A comprehensive testing strategy should cover:
301
+
302
+ ### Functional Testing
303
+ - Verify correct execution with valid/invalid inputs
304
+
305
+ ### Integration Testing
306
+ - Test interaction with external systems
307
+
308
+ ### Security Testing
309
+ - Validate auth, input sanitization, rate limiting
310
+
311
+ ### Performance Testing
312
+ - Check behavior under load, timeouts
313
+
314
+ ### Error Handling
315
+ - Ensure proper error reporting and cleanup
316
+
317
+ ---
318
+
319
+ ## 10. OAuth and Security Best Practices
320
+
321
+ ### Authentication and Authorization
322
+
323
+ MCP servers that connect to external services should implement proper authentication:
324
+
325
+ **OAuth 2.1 Implementation:**
326
+ - Use secure OAuth 2.1 with certificates from recognized authorities
327
+ - Validate access tokens before processing requests
328
+ - Only accept tokens specifically intended for your server
329
+ - Reject tokens without proper audience claims
330
+ - Never pass through tokens received from MCP clients
331
+
332
+ **API Key Management:**
333
+ - Store API keys in environment variables, never in code
334
+ - Validate keys on server startup
335
+ - Provide clear error messages when authentication fails
336
+ - Use secure transmission for sensitive credentials
337
+
338
+ ### Input Validation and Security
339
+
340
+ **Always validate inputs:**
341
+ - Sanitize file paths to prevent directory traversal
342
+ - Validate URLs and external identifiers
343
+ - Check parameter sizes and ranges
344
+ - Prevent command injection in system calls
345
+ - Use schema validation (Pydantic/Zod) for all inputs
346
+
347
+ **Error handling security:**
348
+ - Don't expose internal errors to clients
349
+ - Log security-relevant errors server-side
350
+ - Provide helpful but not revealing error messages
351
+ - Clean up resources after errors
352
+
353
+ ### Privacy and Data Protection
354
+
355
+ **Data collection principles:**
356
+ - Only collect data strictly necessary for functionality
357
+ - Don't collect extraneous conversation data
358
+ - Don't collect PII unless explicitly required for the tool's purpose
359
+ - Provide clear information about what data is accessed
360
+
361
+ **Data transmission:**
362
+ - Don't send data to servers outside your organization without disclosure
363
+ - Use secure transmission (HTTPS) for all network communication
364
+ - Validate certificates for external services
365
+
366
+ ---
367
+
368
+ ## 11. Resource Management Best Practices
369
+
370
+ 1. Only suggest necessary resources
371
+ 2. Use clear, descriptive names for roots
372
+ 3. Handle resource boundaries properly
373
+ 4. Respect client control over resources
374
+ 5. Use model-controlled primitives (tools) for automatic data exposure
375
+
376
+ ---
377
+
378
+ ## 12. Prompt Management Best Practices
379
+
380
+ - Clients should show users proposed prompts
381
+ - Users should be able to modify or reject prompts
382
+ - Clients should show users completions
383
+ - Users should be able to modify or reject completions
384
+ - Consider costs when using sampling
385
+
386
+ ---
387
+
388
+ ## 13. Error Handling Standards
389
+
390
+ - Use standard JSON-RPC error codes
391
+ - Report tool errors within result objects (not protocol-level)
392
+ - Provide helpful, specific error messages
393
+ - Don't expose internal implementation details
394
+ - Clean up resources properly on errors
395
+
396
+ ---
397
+
398
+ ## 14. Documentation Requirements
399
+
400
+ - Provide clear documentation of all tools and capabilities
401
+ - Include working examples (at least 3 per major feature)
402
+ - Document security considerations
403
+ - Specify required permissions and access levels
404
+ - Document rate limits and performance characteristics
405
+
406
+ ---
407
+
408
+ ## 15. Compliance and Monitoring
409
+
410
+ - Implement logging for debugging and monitoring
411
+ - Track tool usage patterns
412
+ - Monitor for potential abuse
413
+ - Maintain audit trails for security-relevant operations
414
+ - Be prepared for ongoing compliance reviews
415
+
416
+ ---
417
+
418
+ ## Summary
419
+
420
+ These best practices represent the comprehensive guidelines for building secure, efficient, and compliant MCP servers that work well within the ecosystem. Developers should follow these guidelines to ensure their MCP servers meet the standards for inclusion in the MCP directory and provide a safe, reliable experience for users.
421
+
422
+
423
+ ----------
424
+
425
+
426
+ # Tools
427
+
428
+ > Enable LLMs to perform actions through your server
429
+
430
+ Tools are a powerful primitive in the Model Context Protocol (MCP) that enable servers to expose executable functionality to clients. Through tools, LLMs can interact with external systems, perform computations, and take actions in the real world.
431
+
432
+ <Note>
433
+ Tools are designed to be **model-controlled**, meaning that tools are exposed from servers to clients with the intention of the AI model being able to automatically invoke them (with a human in the loop to grant approval).
434
+ </Note>
435
+
436
+ ## Overview
437
+
438
+ Tools in MCP allow servers to expose executable functions that can be invoked by clients and used by LLMs to perform actions. Key aspects of tools include:
439
+
440
+ * **Discovery**: Clients can obtain a list of available tools by sending a `tools/list` request
441
+ * **Invocation**: Tools are called using the `tools/call` request, where servers perform the requested operation and return results
442
+ * **Flexibility**: Tools can range from simple calculations to complex API interactions
443
+
444
+ Like [resources](/docs/concepts/resources), tools are identified by unique names and can include descriptions to guide their usage. However, unlike resources, tools represent dynamic operations that can modify state or interact with external systems.
445
+
446
+ ## Tool definition structure
447
+
448
+ Each tool is defined with the following structure:
449
+
450
+ ```typescript
451
+ {
452
+ name: string; // Unique identifier for the tool
453
+ description?: string; // Human-readable description
454
+ inputSchema: { // JSON Schema for the tool's parameters
455
+ type: "object",
456
+ properties: { ... } // Tool-specific parameters
457
+ },
458
+ annotations?: { // Optional hints about tool behavior
459
+ title?: string; // Human-readable title for the tool
460
+ readOnlyHint?: boolean; // If true, the tool does not modify its environment
461
+ destructiveHint?: boolean; // If true, the tool may perform destructive updates
462
+ idempotentHint?: boolean; // If true, repeated calls with same args have no additional effect
463
+ openWorldHint?: boolean; // If true, tool interacts with external entities
464
+ }
465
+ }
466
+ ```
467
+
468
+ ## Implementing tools
469
+
470
+ Here's an example of implementing a basic tool in an MCP server:
471
+
472
+ <Tabs>
473
+ <Tab title="TypeScript">
474
+ ```typescript
475
+ const server = new Server({
476
+ name: "example-server",
477
+ version: "1.0.0"
478
+ }, {
479
+ capabilities: {
480
+ tools: {}
481
+ }
482
+ });
483
+
484
+ // Define available tools
485
+ server.setRequestHandler(ListToolsRequestSchema, async () => {
486
+ return {
487
+ tools: [{
488
+ name: "calculate_sum",
489
+ description: "Add two numbers together",
490
+ inputSchema: {
491
+ type: "object",
492
+ properties: {
493
+ a: { type: "number" },
494
+ b: { type: "number" }
495
+ },
496
+ required: ["a", "b"]
497
+ }
498
+ }]
499
+ };
500
+ });
501
+
502
+ // Handle tool execution
503
+ server.setRequestHandler(CallToolRequestSchema, async (request) => {
504
+ if (request.params.name === "calculate_sum") {
505
+ const { a, b } = request.params.arguments;
506
+ return {
507
+ content: [
508
+ {
509
+ type: "text",
510
+ text: String(a + b)
511
+ }
512
+ ]
513
+ };
514
+ }
515
+ throw new Error("Tool not found");
516
+ });
517
+ ```
518
+ </Tab>
519
+
520
+ <Tab title="Python">
521
+ ```python
522
+ app = Server("example-server")
523
+
524
+ @app.list_tools()
525
+ async def list_tools() -> list[types.Tool]:
526
+ return [
527
+ types.Tool(
528
+ name="calculate_sum",
529
+ description="Add two numbers together",
530
+ inputSchema={
531
+ "type": "object",
532
+ "properties": {
533
+ "a": {"type": "number"},
534
+ "b": {"type": "number"}
535
+ },
536
+ "required": ["a", "b"]
537
+ }
538
+ )
539
+ ]
540
+
541
+ @app.call_tool()
542
+ async def call_tool(
543
+ name: str,
544
+ arguments: dict
545
+ ) -> list[types.TextContent | types.ImageContent | types.EmbeddedResource]:
546
+ if name == "calculate_sum":
547
+ a = arguments["a"]
548
+ b = arguments["b"]
549
+ result = a + b
550
+ return [types.TextContent(type="text", text=str(result))]
551
+ raise ValueError(f"Tool not found: {name}")
552
+ ```
553
+ </Tab>
554
+ </Tabs>
555
+
556
+ ## Example tool patterns
557
+
558
+ Here are some examples of types of tools that a server could provide:
559
+
560
+ ### System operations
561
+
562
+ Tools that interact with the local system:
563
+
564
+ ```typescript
565
+ {
566
+ name: "execute_command",
567
+ description: "Run a shell command",
568
+ inputSchema: {
569
+ type: "object",
570
+ properties: {
571
+ command: { type: "string" },
572
+ args: { type: "array", items: { type: "string" } }
573
+ }
574
+ }
575
+ }
576
+ ```
577
+
578
+ ### API integrations
579
+
580
+ Tools that wrap external APIs:
581
+
582
+ ```typescript
583
+ {
584
+ name: "github_create_issue",
585
+ description: "Create a GitHub issue",
586
+ inputSchema: {
587
+ type: "object",
588
+ properties: {
589
+ title: { type: "string" },
590
+ body: { type: "string" },
591
+ labels: { type: "array", items: { type: "string" } }
592
+ }
593
+ }
594
+ }
595
+ ```
596
+
597
+ ### Data processing
598
+
599
+ Tools that transform or analyze data:
600
+
601
+ ```typescript
602
+ {
603
+ name: "analyze_csv",
604
+ description: "Analyze a CSV file",
605
+ inputSchema: {
606
+ type: "object",
607
+ properties: {
608
+ filepath: { type: "string" },
609
+ operations: {
610
+ type: "array",
611
+ items: {
612
+ enum: ["sum", "average", "count"]
613
+ }
614
+ }
615
+ }
616
+ }
617
+ }
618
+ ```
619
+
620
+ ## Best practices
621
+
622
+ When implementing tools:
623
+
624
+ 1. Provide clear, descriptive names and descriptions
625
+ 2. Use detailed JSON Schema definitions for parameters
626
+ 3. Include examples in tool descriptions to demonstrate how the model should use them
627
+ 4. Implement proper error handling and validation
628
+ 5. Use progress reporting for long operations
629
+ 6. Keep tool operations focused and atomic
630
+ 7. Document expected return value structures
631
+ 8. Implement proper timeouts
632
+ 9. Consider rate limiting for resource-intensive operations
633
+ 10. Log tool usage for debugging and monitoring
634
+
635
+ ### Tool name conflicts
636
+
637
+ MCP client applications and MCP server proxies may encounter tool name conflicts when building their own tool lists. For example, two connected MCP servers `web1` and `web2` may both expose a tool named `search_web`.
638
+
639
+ Applications may disambiguiate tools with one of the following strategies (among others; not an exhaustive list):
640
+
641
+ * Concatenating a unique, user-defined server name with the tool name, e.g. `web1___search_web` and `web2___search_web`. This strategy may be preferable when unique server names are already provided by the user in a configuration file.
642
+ * Generating a random prefix for the tool name, e.g. `jrwxs___search_web` and `6cq52___search_web`. This strategy may be preferable in server proxies where user-defined unique names are not available.
643
+ * Using the server URI as a prefix for the tool name, e.g. `web1.example.com:search_web` and `web2.example.com:search_web`. This strategy may be suitable when working with remote MCP servers.
644
+
645
+ Note that the server-provided name from the initialization flow is not guaranteed to be unique and is not generally suitable for disambiguation purposes.
646
+
647
+ ## Security considerations
648
+
649
+ When exposing tools:
650
+
651
+ ### Input validation
652
+
653
+ * Validate all parameters against the schema
654
+ * Sanitize file paths and system commands
655
+ * Validate URLs and external identifiers
656
+ * Check parameter sizes and ranges
657
+ * Prevent command injection
658
+
659
+ ### Access control
660
+
661
+ * Implement authentication where needed
662
+ * Use appropriate authorization checks
663
+ * Audit tool usage
664
+ * Rate limit requests
665
+ * Monitor for abuse
666
+
667
+ ### Error handling
668
+
669
+ * Don't expose internal errors to clients
670
+ * Log security-relevant errors
671
+ * Handle timeouts appropriately
672
+ * Clean up resources after errors
673
+ * Validate return values
674
+
675
+ ## Tool discovery and updates
676
+
677
+ MCP supports dynamic tool discovery:
678
+
679
+ 1. Clients can list available tools at any time
680
+ 2. Servers can notify clients when tools change using `notifications/tools/list_changed`
681
+ 3. Tools can be added or removed during runtime
682
+ 4. Tool definitions can be updated (though this should be done carefully)
683
+
684
+ ## Error handling
685
+
686
+ Tool errors should be reported within the result object, not as MCP protocol-level errors. This allows the LLM to see and potentially handle the error. When a tool encounters an error:
687
+
688
+ 1. Set `isError` to `true` in the result
689
+ 2. Include error details in the `content` array
690
+
691
+ Here's an example of proper error handling for tools:
692
+
693
+ <Tabs>
694
+ <Tab title="TypeScript">
695
+ ```typescript
696
+ try {
697
+ // Tool operation
698
+ const result = performOperation();
699
+ return {
700
+ content: [
701
+ {
702
+ type: "text",
703
+ text: `Operation successful: ${result}`
704
+ }
705
+ ]
706
+ };
707
+ } catch (error) {
708
+ return {
709
+ isError: true,
710
+ content: [
711
+ {
712
+ type: "text",
713
+ text: `Error: ${error.message}`
714
+ }
715
+ ]
716
+ };
717
+ }
718
+ ```
719
+ </Tab>
720
+
721
+ <Tab title="Python">
722
+ ```python
723
+ try:
724
+ # Tool operation
725
+ result = perform_operation()
726
+ return types.CallToolResult(
727
+ content=[
728
+ types.TextContent(
729
+ type="text",
730
+ text=f"Operation successful: {result}"
731
+ )
732
+ ]
733
+ )
734
+ except Exception as error:
735
+ return types.CallToolResult(
736
+ isError=True,
737
+ content=[
738
+ types.TextContent(
739
+ type="text",
740
+ text=f"Error: {str(error)}"
741
+ )
742
+ ]
743
+ )
744
+ ```
745
+ </Tab>
746
+ </Tabs>
747
+
748
+ This approach allows the LLM to see that an error occurred and potentially take corrective action or request human intervention.
749
+
750
+ ## Tool annotations
751
+
752
+ Tool annotations provide additional metadata about a tool's behavior, helping clients understand how to present and manage tools. These annotations are hints that describe the nature and impact of a tool, but should not be relied upon for security decisions.
753
+
754
+ ### Purpose of tool annotations
755
+
756
+ Tool annotations serve several key purposes:
757
+
758
+ 1. Provide UX-specific information without affecting model context
759
+ 2. Help clients categorize and present tools appropriately
760
+ 3. Convey information about a tool's potential side effects
761
+ 4. Assist in developing intuitive interfaces for tool approval
762
+
763
+ ### Available tool annotations
764
+
765
+ The MCP specification defines the following annotations for tools:
766
+
767
+ | Annotation | Type | Default | Description |
768
+ | ----------------- | ------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------ |
769
+ | `title` | string | - | A human-readable title for the tool, useful for UI display |
770
+ | `readOnlyHint` | boolean | false | If true, indicates the tool does not modify its environment |
771
+ | `destructiveHint` | boolean | true | If true, the tool may perform destructive updates (only meaningful when `readOnlyHint` is false) |
772
+ | `idempotentHint` | boolean | false | If true, calling the tool repeatedly with the same arguments has no additional effect (only meaningful when `readOnlyHint` is false) |
773
+ | `openWorldHint` | boolean | true | If true, the tool may interact with an "open world" of external entities |
774
+
775
+ ### Example usage
776
+
777
+ Here's how to define tools with annotations for different scenarios:
778
+
779
+ ```typescript
780
+ // A read-only search tool
781
+ {
782
+ name: "web_search",
783
+ description: "Search the web for information",
784
+ inputSchema: {
785
+ type: "object",
786
+ properties: {
787
+ query: { type: "string" }
788
+ },
789
+ required: ["query"]
790
+ },
791
+ annotations: {
792
+ title: "Web Search",
793
+ readOnlyHint: true,
794
+ openWorldHint: true
795
+ }
796
+ }
797
+
798
+ // A destructive file deletion tool
799
+ {
800
+ name: "delete_file",
801
+ description: "Delete a file from the filesystem",
802
+ inputSchema: {
803
+ type: "object",
804
+ properties: {
805
+ path: { type: "string" }
806
+ },
807
+ required: ["path"]
808
+ },
809
+ annotations: {
810
+ title: "Delete File",
811
+ readOnlyHint: false,
812
+ destructiveHint: true,
813
+ idempotentHint: true,
814
+ openWorldHint: false
815
+ }
816
+ }
817
+
818
+ // A non-destructive database record creation tool
819
+ {
820
+ name: "create_record",
821
+ description: "Create a new record in the database",
822
+ inputSchema: {
823
+ type: "object",
824
+ properties: {
825
+ table: { type: "string" },
826
+ data: { type: "object" }
827
+ },
828
+ required: ["table", "data"]
829
+ },
830
+ annotations: {
831
+ title: "Create Database Record",
832
+ readOnlyHint: false,
833
+ destructiveHint: false,
834
+ idempotentHint: false,
835
+ openWorldHint: false
836
+ }
837
+ }
838
+ ```
839
+
840
+ ### Integrating annotations in server implementation
841
+
842
+ <Tabs>
843
+ <Tab title="TypeScript">
844
+ ```typescript
845
+ server.setRequestHandler(ListToolsRequestSchema, async () => {
846
+ return {
847
+ tools: [{
848
+ name: "calculate_sum",
849
+ description: "Add two numbers together",
850
+ inputSchema: {
851
+ type: "object",
852
+ properties: {
853
+ a: { type: "number" },
854
+ b: { type: "number" }
855
+ },
856
+ required: ["a", "b"]
857
+ },
858
+ annotations: {
859
+ title: "Calculate Sum",
860
+ readOnlyHint: true,
861
+ openWorldHint: false
862
+ }
863
+ }]
864
+ };
865
+ });
866
+ ```
867
+ </Tab>
868
+
869
+ <Tab title="Python">
870
+ ```python
871
+ from mcp.server.fastmcp import FastMCP
872
+
873
+ mcp = FastMCP("example-server")
874
+
875
+ @mcp.tool(
876
+ annotations={
877
+ "title": "Calculate Sum",
878
+ "readOnlyHint": True,
879
+ "openWorldHint": False
880
+ }
881
+ )
882
+ async def calculate_sum(a: float, b: float) -> str:
883
+ """Add two numbers together.
884
+
885
+ Args:
886
+ a: First number to add
887
+ b: Second number to add
888
+ """
889
+ result = a + b
890
+ return str(result)
891
+ ```
892
+ </Tab>
893
+ </Tabs>
894
+
895
+ ### Best practices for tool annotations
896
+
897
+ 1. **Be accurate about side effects**: Clearly indicate whether a tool modifies its environment and whether those modifications are destructive.
898
+
899
+ 2. **Use descriptive titles**: Provide human-friendly titles that clearly describe the tool's purpose.
900
+
901
+ 3. **Indicate idempotency properly**: Mark tools as idempotent only if repeated calls with the same arguments truly have no additional effect.
902
+
903
+ 4. **Set appropriate open/closed world hints**: Indicate whether a tool interacts with a closed system (like a database) or an open system (like the web).
904
+
905
+ 5. **Remember annotations are hints**: All properties in ToolAnnotations are hints and not guaranteed to provide a faithful description of tool behavior. Clients should never make security-critical decisions based solely on annotations.
906
+
907
+ ## Testing tools
908
+
909
+ A comprehensive testing strategy for MCP tools should cover:
910
+
911
+ * **Functional testing**: Verify tools execute correctly with valid inputs and handle invalid inputs appropriately
912
+ * **Integration testing**: Test tool interaction with external systems using both real and mocked dependencies
913
+ * **Security testing**: Validate authentication, authorization, input sanitization, and rate limiting
914
+ * **Performance testing**: Check behavior under load, timeout handling, and resource cleanup
915
+ * **Error handling**: Ensure tools properly report errors through the MCP protocol and clean up resources