xmcp 0.6.5 → 0.6.7

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 (78) hide show
  1. package/README.md +32 -0
  2. package/dist/cli.js +58 -40
  3. package/dist/compiler/config/index.d.ts +106 -47
  4. package/dist/compiler/config/schemas/template.d.ts +40 -0
  5. package/dist/compiler/config/schemas/transport/http.d.ts +82 -82
  6. package/dist/compiler/config/schemas/transport/stdio.d.ts +5 -0
  7. package/dist/index.d.ts +4 -2
  8. package/dist/index.js +5 -5
  9. package/dist/runtime/adapter-express.js +40 -23
  10. package/dist/runtime/adapter-nestjs.js +40 -23
  11. package/dist/runtime/adapter-nextjs.js +39 -22
  12. package/dist/runtime/contexts/http-request-context.d.ts +3 -1
  13. package/dist/runtime/headers.js +1 -1
  14. package/dist/runtime/http.js +48 -31
  15. package/dist/runtime/stdio.js +19 -13
  16. package/dist/runtime/utils/elicitation.d.ts +4 -0
  17. package/dist/runtime/utils/ext-apps-registry.d.ts +132 -0
  18. package/dist/runtime/utils/path-to-tool-name.d.ts +20 -0
  19. package/dist/runtime/utils/prompt-loader.d.ts +11 -0
  20. package/dist/runtime/utils/prompts.d.ts +8 -0
  21. package/dist/runtime/utils/react/generate-html.d.ts +1 -0
  22. package/dist/runtime/utils/react/index.d.ts +4 -0
  23. package/dist/runtime/utils/resource-loader.d.ts +11 -0
  24. package/dist/runtime/utils/resources.d.ts +4 -0
  25. package/dist/runtime/utils/server.d.ts +35 -0
  26. package/dist/runtime/utils/tool-loader.d.ts +11 -0
  27. package/dist/runtime/utils/tools.d.ts +11 -0
  28. package/dist/runtime/utils/transformers/prompt.d.ts +32 -0
  29. package/dist/runtime/utils/transformers/resource.d.ts +26 -0
  30. package/dist/runtime/utils/transformers/tool.d.ts +30 -0
  31. package/dist/runtime/utils/ui/flatten-meta.d.ts +6 -0
  32. package/dist/runtime/utils/ui/split-meta.d.ts +17 -0
  33. package/dist/runtime/utils/utils/resource-uri-composer.d.ts +60 -0
  34. package/dist/runtime/utils/validators/index.d.ts +13 -0
  35. package/dist/types/client-info.d.ts +12 -0
  36. package/dist/types/tool.d.ts +70 -14
  37. package/dist/utils/context.d.ts +1 -1
  38. package/package.json +9 -1
  39. package/src/client/index.ts +4 -1
  40. package/src/compiler/config/__tests__/config.test.ts +36 -0
  41. package/src/compiler/config/injection.ts +63 -1
  42. package/src/compiler/config/schemas/template.ts +17 -0
  43. package/src/compiler/config/schemas/transport/stdio.ts +1 -0
  44. package/src/compiler/generate-tools-code.ts +24 -6
  45. package/src/compiler/get-bundler-config/get-injected-variables.ts +3 -0
  46. package/src/compiler/get-bundler-config/plugins/index.ts +0 -1
  47. package/src/compiler/index.ts +123 -30
  48. package/src/compiler/start-http-server.ts +11 -4
  49. package/src/compiler/watcher-recovery.ts +72 -0
  50. package/src/index.ts +9 -1
  51. package/src/runtime/adapters/express/index.ts +45 -47
  52. package/src/runtime/adapters/nestjs/xmcp.service.ts +4 -3
  53. package/src/runtime/adapters/nextjs/handler/node-to-web-adapter.ts +40 -6
  54. package/src/runtime/adapters/nextjs/handler/request-converter.ts +20 -0
  55. package/src/runtime/adapters/nextjs/handler/server-lifecycle.ts +8 -5
  56. package/src/runtime/adapters/nextjs/index.ts +41 -25
  57. package/src/runtime/contexts/http-request-context.ts +2 -0
  58. package/src/runtime/headers.ts +37 -2
  59. package/src/runtime/platforms/cloudflare/cors.ts +0 -1
  60. package/src/runtime/platforms/cloudflare/worker.ts +46 -44
  61. package/src/runtime/transports/http/index.ts +0 -4
  62. package/src/runtime/transports/http/stateless-streamable-http.ts +131 -233
  63. package/src/runtime/transports/stdio/index.ts +18 -1
  64. package/src/runtime/utils/__tests__/client-info.test.ts +80 -0
  65. package/src/runtime/utils/__tests__/tool-extra.test.ts +110 -0
  66. package/src/runtime/utils/client-info.ts +71 -0
  67. package/src/runtime/utils/elicitation.ts +396 -0
  68. package/src/runtime/utils/prompt-loader.ts +151 -0
  69. package/src/runtime/utils/resource-loader.ts +151 -0
  70. package/src/runtime/utils/resources.ts +0 -8
  71. package/src/runtime/utils/server.ts +30 -42
  72. package/src/runtime/utils/tool-loader.ts +149 -0
  73. package/src/runtime/utils/tools.ts +31 -9
  74. package/src/runtime/utils/transformers/tool.ts +149 -10
  75. package/src/types/client-info.ts +12 -0
  76. package/src/types/injected.d.ts +62 -0
  77. package/src/types/tool.ts +100 -17
  78. package/src/utils/context.ts +2 -2
package/README.md CHANGED
@@ -45,6 +45,38 @@ npx init-xmcp@latest
45
45
  ⊹ Visit [xmcp.dev](https://xmcp.dev) to learn more about the project.\
46
46
  ⊹ Visit [xmcp.dev/docs](https://xmcp.dev/docs) to view the full documentation.
47
47
 
48
+ ## Tool Elicitation
49
+
50
+ Tool handlers can request user input with `extra.elicit()`:
51
+
52
+ ```ts
53
+ export default async function (_args, extra) {
54
+ const result = await extra.elicit({
55
+ message: "Choose a deployment target",
56
+ requestedSchema: {
57
+ type: "object",
58
+ properties: {
59
+ environment: {
60
+ type: "string",
61
+ title: "Environment",
62
+ enum: ["staging", "production"],
63
+ },
64
+ },
65
+ required: ["environment"],
66
+ },
67
+ });
68
+
69
+ if (result.action !== "accept" || !result.content) {
70
+ return "Deployment cancelled.";
71
+ }
72
+
73
+ return `Deploying to ${result.content.environment}`;
74
+ }
75
+ ```
76
+
77
+ Form mode is intentionally limited to flat primitive fields and string enums.
78
+ Use URL mode for auth, API key, payment, or other sensitive flows.
79
+
48
80
  ## Security
49
81
 
50
82
  If you believe you have found a security vulnerability, we encourage you to let us know right away.