v0.3.0 (#160)

* feat(create-xmcp-app): Add option to customize initialized components

* nextjs adapter to work on any route

* update lock

* resource metadata

* add resource paths & generate resources import cod

* injected resources config

* export resource metadata

* path validation

* URI composing logic based on folder convention

* remove extra servercapabilities import

* loadResources + configure server + nextjs adapter implementation

* add resources to examples

* create-xmcp-app CLI support for resources (#158)

* update create-xmcp-app cli template gen to support resources

* initialize resources to true

* init-xmcp support for resources (#159)

* add resources path and template creation for init-xmcp

* fix typo

* ensure subdirs are created

* resources examples nit

---------

Co-authored-by: FranFigueroa <[email protected]>

Author: valebearzotti

examples/http-transport/src/resources/(config)/app.ts

@@ -0,0 +1,11 @@
+import { type ResourceMetadata } from "xmcp";
+
+export const metadata: ResourceMetadata = {
+  name: "app-config",
+  title: "Application Config",
+  description: "Application configuration data",
+};
+
+export default function handler() {
+  return "App configuration here";
+}

examples/http-transport/src/resources/(github)/repos/[owner]/[repo]/index.ts

@@ -0,0 +1,17 @@
+import { z } from "zod";
+import { type ResourceMetadata, type InferSchema } from "xmcp";
+
+export const schema = {
+  owner: z.string().describe("The owner of the repository"),
+  repo: z.string().describe("The name of the repository"),
+};
+
+export const metadata: ResourceMetadata = {
+  name: "github-repo",
+  title: "GitHub Repository",
+  description: "GitHub repository information",
+};
+
+export default function handler({ owner, repo }: InferSchema<typeof schema>) {
+  return `Repository: ${owner}/${repo}`;
+}

examples/http-transport/src/resources/(users)/[userId]/profile.ts

@@ -0,0 +1,16 @@
+import { z } from "zod";
+import { type ResourceMetadata, type InferSchema } from "xmcp";
+
+export const schema = {
+  userId: z.string().describe("The ID of the user"),
+};
+
+export const metadata: ResourceMetadata = {
+  name: "user-profile",
+  title: "User Profile",
+  description: "User profile information",
+};
+
+export default function handler({ userId }: InferSchema<typeof schema>) {
+  return `Profile data for user ${userId}`;
+}

examples/stdio-transport/src/resources/(config)/app.ts

@@ -0,0 +1,11 @@
+import { type ResourceMetadata } from "xmcp";
+
+export const metadata: ResourceMetadata = {
+  name: "app-config",
+  title: "Application Config",
+  description: "Application configuration data",
+};
+
+export default function handler() {
+  return "App configuration here";
+}

examples/stdio-transport/src/resources/(github)/repos/[owner]/[repo]/index.ts

@@ -0,0 +1,17 @@
+import { z } from "zod";
+import { type ResourceMetadata, type InferSchema } from "xmcp";
+
+export const schema = {
+  owner: z.string().describe("The owner of the repository"),
+  repo: z.string().describe("The name of the repository"),
+};
+
+export const metadata: ResourceMetadata = {
+  name: "github-repo",
+  title: "GitHub Repository",
+  description: "GitHub repository information",
+};
+
+export default function handler({ owner, repo }: InferSchema<typeof schema>) {
+  return `Repository: ${owner}/${repo}`;
+}

examples/stdio-transport/src/resources/(users)/[userId]/profile.ts

@@ -0,0 +1,16 @@
+import { z } from "zod";
+import { type ResourceMetadata, type InferSchema } from "xmcp";
+
+export const schema = {
+  userId: z.string().describe("The ID of the user"),
+};
+
+export const metadata: ResourceMetadata = {
+  name: "user-profile",
+  title: "User Profile",
+  description: "User profile information",
+};
+
+export default function handler({ userId }: InferSchema<typeof schema>) {
+  return `Profile data for user ${userId}`;
+}

packages/create-xmcp-app/package.json

@@ -50,8 +50,9 @@
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4",
-    "@types/inquirer": "^9.0.7",
+    "@types/inquirer": "^9.0.9",
     "@types/node": "^20.17.47",
+    "@types/ora": "^3.1.0",
     "typescript": "^5.3.3"
   }
 }

packages/create-xmcp-app/src/helpers/copy-template.ts

@@ -5,11 +5,28 @@ import fs from "fs-extra";
  * Copy template files to the project directory, excluding unnecessary files
  * @param templateDir - Source template directory path
  * @param projectPath - Destination project directory path
+ * @param paths - Array of paths to include (tools, prompts, resources)
  */
-export function copyTemplate(templateDir: string, projectPath: string): void {
+export function copyTemplate(
+  templateDir: string,
+  projectPath: string,
+  paths: string[] = ["tools", "prompts", "resources"]
+): void {
   fs.copySync(templateDir, projectPath, {
     filter: (src) => {
       const basename = path.basename(src);
+      const relativePath = path.relative(templateDir, src);
+      const srcDir = path.dirname(relativePath).split(path.sep)[0];
+
+      // Check if this is a source directory that should be included based on user selection
+      if (srcDir === "src") {
+        const subDir = relativePath.split(path.sep)[1];
+        if (subDir === "tools" && !paths.includes("tools")) return false;
+        if (subDir === "prompts" && !paths.includes("prompts")) return false;
+        if (subDir === "resources" && !paths.includes("resources"))
+          return false;
+      }
+
       return (
         // node_modules could be skipped
         basename !== "node_modules" &&

packages/create-xmcp-app/src/helpers/create.ts

@@ -17,6 +17,7 @@ interface ProjectOptions {
   transports: string[];
   packageVersion: string;
   skipInstall?: boolean;
+  paths?: string[];
 }
 
 /**
@@ -39,6 +40,7 @@ export function createProject(options: ProjectOptions): void {
     transports,
     packageVersion,
     skipInstall,
+    paths = ["tools", "prompts"],
   } = options;
 
   // Ensure the project directory exists
@@ -48,13 +50,13 @@ export function createProject(options: ProjectOptions): void {
   const templateDir = path.join(__dirname, "../../templates", "typescript");
 
   // Copy template files to project directory
-  copyTemplate(templateDir, projectPath);
+  copyTemplate(templateDir, projectPath, paths);
 
   // Rename special files (e.g., _gitignore to .gitignore)
   renameFiles(projectPath);
 
-  // Generate xmcp.config.ts based on selected transports
-  generateConfig(projectPath, transports);
+  // Generate xmcp.config.ts based on selected transports and paths
+  generateConfig(projectPath, transports, paths);
 
   // Update package.json with project configuration
   updatePackageJson(projectPath, projectName, transports);

packages/create-xmcp-app/src/helpers/generate-config.ts

@@ -2,13 +2,15 @@ import path from "path";
 import fs from "fs-extra";
 
 /**
- * Generate xmcp.config.ts based on selected transports
+ * Generate xmcp.config.ts based on selected transports and paths
  * @param projectPath - Project directory path
  * @param transports - Array of selected transport types
+ * @param paths - Array of selected paths (tools, prompts)
  */
 export function generateConfig(
   projectPath: string,
-  transports: string[]
+  transports: string[],
+  paths: string[] = ["tools", "prompts", "resources"]
 ): void {
   const hasHttp = transports.includes("http");
   const hasStdio = transports.includes("stdio");
@@ -27,6 +29,37 @@ const config: XmcpConfig = {`;
   stdio: true,`;
   }
 
+  // Add paths configuration
+  configContent += `
+  paths: {`;
+
+  // Add tools path if selected
+  if (paths.includes("tools")) {
+    configContent += `
+    tools: "./src/tools",`;
+  }
+
+  // Add prompts path if selected
+  if (paths.includes("prompts")) {
+    configContent += `
+    prompts: "./src/prompts",`;
+  }
+
+  // Add resources path if selected
+  if (paths.includes("resources")) {
+    configContent += `
+    resources: "./src/resources",`;
+  }
+
+  // Close the paths object
+  configContent += `
+  },`;
+
+  // Remove trailing comma if present
+  configContent = configContent.endsWith(",")
+    ? configContent.slice(0, -1)
+    : configContent;
+
   configContent += `
 };