add new templates and instrumentation scripts

Author: adrianescutia

.github/main.yaml

@@ -5,12 +5,16 @@ on:
     branches:
       - main
   workflow_dispatch:  # Allows manual triggering
+  pull_request:
+  release:
+    types: [published]
 
-permissions:
-  contents: write
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
-  publish:
+  build:
     runs-on: ubuntu-latest
 
     steps:
@@ -24,19 +28,42 @@ jobs:
         with:
           node-version: '18'
           registry-url: 'https://registry.npmjs.org'
+          cache: npm
 
       - name: Install dependencies
         run: npm ci
 
       - name: Build project
         run: npm run build
 
-      - name: Configure Git
+      - name: Test creation from template
         run: |
-          git config --local user.email "action@github.com"
-          git config --local user.name "GitHub Action"
+          ./build/index.js test-server --name test-server --description "Here is a test server" --tool "Echo"
+
+      - name: Validate generated project
+        run: npm install && npm run build && npm link
+        working-directory: test-server
+
+  publish:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release'
+    # environment: release
+    needs: build
+
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: npm
+          registry-url: 'https://registry.npmjs.org'
+
+      - run: npm ci
 
-      - name: Publish to npm
-        run: npm publish --access public
+      - run: npm publish --access public
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,3 +1,6 @@
+# custom
+/agentico-project
+
 # Logs
 logs
 *.log

README.md

@@ -1,4 +1,6 @@
-# mcp-create-tool ![NPM Version](https://img.shields.io/npm/v/%40agentico%2Fmcp-create-tool)
+# mcp-create-tool
+![NPM Version](https://img.shields.io/npm/v/%40agentico%2Fmcp-create-tool)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fagentico%2Fmcp-create-tool.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2agentico%2Fmcp-create-tool?ref=badge_shield)
 
 A command line tool for quickly scaffolding new MCP (Model Context Protocol) tools to be used with the Agentico's MCPServer, an open-source server `facade` implementation for the Model Context Protocol.

package-lock.json

@@ -1,15 +1,25 @@
 {
   "name": "@agentico/mcp-create-tool",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "CLI tool to create new Agentico MCP tools",
   "license": "MIT",
   "author": {
     "name": "Agentico",
     "url": "https://agentico.dev"
   },
+  "contributors": [
+    {
+      "name": "Adrian Escutia",
+      "url": "https://escutia.me/adrian"
+    },
+    {
+      "name": "La Rebelion Labs",
+      "url": "https://rebelion.la"
+    }
+  ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/agentico-dev/mcp-create-tool"
+    "url": "git+https://github.com/agentico-dev/mcp-create-tool.git"
   },
   "homepage": "https://agentico.dev",
   "bugs": "https://github.com/agentico-dev/mcp-create-tool/issues",
@@ -32,10 +42,12 @@
     "commander": "^13.0.0",
     "ejs": "^3.1.10",
     "is-wsl": "^3.1.0",
+    "lodash": "^4.17.21",
     "ora": "^8.1.1"
   },
   "devDependencies": {
     "@types/ejs": "^3.1.5",
+    "@types/lodash": "^4.17.15",
     "@types/node": "^20.11.24",
     "shx": "^0.3.4",
     "typescript": "^5.3.3"

package.json

@@ -12,7 +12,9 @@ import { promisify } from 'util'
 import { fileURLToPath } from "url";
 import { ExitPromptError } from "@inquirer/core";
 import isWsl from 'is-wsl';
+import lodash from 'lodash';
 
+const TRACES_DEFAULT_URL = "http://localhost:4318/v1/traces";
 const __dirname = path.dirname(fileURLToPath(import.meta.url));
 async function getClaudeConfigDir(): Promise<string> {
   if (isWsl) {
@@ -150,7 +152,15 @@ async function createServer(directory: string, options: any = {}) {
     installForClaude: {
       message: "Would you like to install this server for Claude.app?",
       required: false,
-    }
+    },
+    instrumentation: {
+      message: "Would you like to add OpenTelemetry instrumentation?",
+      required: false,
+    },
+    traceExporterUrl: {
+      message: "What is the URL of the trace exporter?",
+      required: false,
+    },
   };
 
   interface Question {
@@ -164,8 +174,11 @@ async function createServer(directory: string, options: any = {}) {
     description: Question;
     tool: Question;
     installForClaude: Question;
+    instrumentation: Question;
+    traceExporterUrl: Question;
   }
 
+  // Ask questions to the user and return the answers
   const answersInquirer = async (questions: Questions): Promise<any> => {
     const name = await input({ ...questions.name, validate: (value) => value.length > 3 || 'Name must be at least 4 characters' });
     const description = await input(questions.description);
@@ -180,30 +193,83 @@ async function createServer(directory: string, options: any = {}) {
       message: "Would you like to install this server for Claude.app?",
       default: true
     }) : false;
-    console.debug({ name, description, tool, installForClaude });
-    return { name, description, tool, installForClaude };
+    const instrumentation = await confirm({
+      message: "Would you like to add OpenTelemetry instrumentation?",
+      default: false
+    });
+    let traceExporterUrl;
+    if (instrumentation) {
+      traceExporterUrl = await input({
+        ...questions.traceExporterUrl,
+        message: "What is the URL of the trace exporter?",
+        required: true,
+        default: TRACES_DEFAULT_URL,
+      });
+    }
+    return { name, description, tool, installForClaude, instrumentation, traceExporterUrl };
   };
 
   const answers = await answersInquirer(questions);
-  const { name, description, tool, installForClaude } = answers;
 
+  // Tool name in PascalCase, removing special characters
+  const toolPascalCase = lodash.upperFirst(lodash.camelCase(answers.tool)).replace(/[^a-zA-Z0-9_]/g, '');
+  // Configuration based on user answers, or default values
   const config = {
-    name: options.name || name,
-    description: options.description || description,
-    tool: options.tool || tool,
-    installForClaude: options.installForClaude || installForClaude
+    // Remove special characters from name
+    name: (options.name || answers.name).replace(/[^a-zA-Z0-9_]/g, ''),
+    description: options.description || answers.description,
+    tool: options.tool || answers.tool,
+    installForClaude: options.installForClaude || answers.installForClaude,
+    instrumentation: options.instrumentation || answers.instrumentation,
+    traceExporterUrl: options.traceExporterUrl || answers.traceExporterUrl,
+    toolPascalCase,
   };
 
+  console.debug(`Using configuration: ${JSON.stringify(config, null, 2)}`);
   const spinner = ora("Creating MCP server...").start();
 
   try {
     // Create project directory
     await fs.mkdir(directory);
 
-    // Copy template files
-    const templateDir = path.join(__dirname, "../template");
+    // render template files
+    const templateDir = path.join(__dirname, "../template/project");
     const files = await fs.readdir(templateDir, { recursive: true });
+    await processTemplateFiles(files, templateDir);
+    // Process additional files if needed
+    if (config.instrumentation) {
+      const instrumentationDir = path.join(__dirname, "../template/instrumentation");
+      const instrumentationFiles = await fs.readdir(instrumentationDir, { recursive: true });
+      await processTemplateFiles(instrumentationFiles, instrumentationDir);
+    }
+
+    spinner.succeed(chalk.green("MCP server created successfully!"));
+
+    if (answers.installForClaude) {
+      await updateClaudeConfig(config.name, directory);
+    }
+
+    // Print next steps
+    console.log("\nNext steps:");
+    console.log(chalk.cyan(`  cd ${directory}`));
+    console.log(chalk.cyan("  npm install"));
+    console.log(
+      chalk.cyan(`  npm run build  ${chalk.reset("# or: npm run watch")}`),
+    );
+    console.log(
+      chalk.cyan(
+        `  npm link       ${chalk.reset("# optional, to make available globally")}\n`,
+      ),
+    );
+    console.log(chalk.yellow("Test it in your browser:"));
+    console.log(chalk.cyan("  npm run inspector\n"));
+  } catch (error) {
+    spinner.fail(chalk.red("Failed to create MCP server"));
+    console.error(error);
+    process.exit(1);
+  }
 
+  async function processTemplateFiles(files: string[], templateDir: string) {
     for (const file of files) {
       const sourcePath = path.join(templateDir, file);
       const stats = await fs.stat(sourcePath);
@@ -231,37 +297,12 @@ async function createServer(directory: string, options: any = {}) {
       // Write processed file
       await fs.writeFile(targetPath, content);
     }
-
-    spinner.succeed(chalk.green("MCP server created successfully!"));
-
-    if (answers.installForClaude) {
-      await updateClaudeConfig(config.name, directory);
-    }
-
-    // Print next steps
-    console.log("\nNext steps:");
-    console.log(chalk.cyan(`  cd ${directory}`));
-    console.log(chalk.cyan("  npm install"));
-    console.log(
-      chalk.cyan(`  npm run build  ${chalk.reset("# or: npm run watch")}`),
-    );
-    console.log(
-      chalk.cyan(
-        `  npm link       ${chalk.reset("# optional, to make available globally")}\n`,
-      ),
-    );
-    console.log(chalk.yellow("Test it in your browser:"));
-    console.log(chalk.cyan("  npm run inspector\n"));
-  } catch (error) {
-    spinner.fail(chalk.red("Failed to create MCP server"));
-    console.error(error);
-    process.exit(1);
   }
 }
 
 // detect ctrl+c and exit
 process.on("SIGINT", () => {
-  console.log(chalk.yellow("\nAborted."));
+  console.log(chalk.red("\nAborted, process interrupted."));
   process.exit(0);
 });
 
@@ -273,6 +314,9 @@ try {
     .option("-n, --name <name>", "Name of the server")
     .option("-d, --description <description>", "Description of the server")
     .option("-t, --tool <tool>", "Name of the tool to create")
+    // .option("--no-install", "Skip configure the server for Claude.app", true)
+    .option("-i, --instrumentation", "Add OpenTelemetry instrumentation", false)
+    .option("-e, --trace-exporter-url <url>", "URL of the trace exporter, only if instrumentation", TRACES_DEFAULT_URL)
     .action(createServer);
 
   program.showHelpAfterError('(add --help for additional information)');

src/index.ts

@@ -0,0 +1,34 @@
+receivers:
+  otlp:
+    protocols:
+      http:
+        include_metadata: true
+        endpoint: 0.0.0.0:4318
+
+processors:
+  batch: # Batches spans before exporting
+    timeout: 5s
+
+exporters:
+  # otlp: # Exports traces to Jaeger
+  #   endpoint: "http://host.docker.internal:14250"
+  #   tls:
+  #     insecure: true
+  otlphttp:
+    endpoint: "http://agenticotel-collector:4318"
+    tls:
+      insecure: true
+  debug:
+    verbosity: detailed
+
+service:
+  pipelines:
+    traces:
+      receivers: [otlp]
+      processors: [batch]
+      # exporters: [debug, otlphttp, otlp]
+      exporters: [debug, otlphttp]
+    logs:
+      receivers: [otlp]
+      processors: [batch]
+      exporters: [otlphttp]