simple-dynamsoft-mcp 2.1.0 → 2.2.0

package/README.md

@@ -26,9 +26,11 @@ https://github.com/user-attachments/assets/cc1c5f4b-1461-4462-897a-75abc20d62a6
 | `get_sdk_info` | Get detailed SDK info for a specific platform |
 | `list_samples` | List mobile code samples |
 | `list_python_samples` | List Python SDK samples |
+| `list_web_samples` | List web barcode reader samples |
 | `list_dwt_categories` | List Dynamic Web TWAIN sample categories |
 | `get_code_snippet` | Get mobile sample source code |
 | `get_python_sample` | Get Python sample code |
+| `get_web_sample` | Get web barcode reader sample HTML/JS code |
 | `get_dwt_sample` | Get Dynamic Web TWAIN sample |
 | `get_quick_start` | Complete quick start guide with dependencies |
 | `get_gradle_config` | Android Gradle configuration |
@@ -194,6 +196,12 @@ If you prefer running from source:
 
 **CDN:** `https://cdn.jsdelivr.net/npm/dynamsoft-barcode-reader-bundle@11.2.4000/dist/dbr.bundle.min.js`
 
+**Samples:**
+- **hello-world** - Basic barcode scanning from camera
+- **read-an-image** - Decode from image files
+- **frameworks/** - React, Vue, Angular, Next.js, PWA samples
+- **scenarios/** - Multi-image reading, localize an item, driver license parsing
+
 ### Dynamic Web TWAIN (v19.3)
 
 **Installation:** `npm install dwt`
@@ -224,6 +232,12 @@ After connecting the MCP server, you can ask your AI assistant:
 - "Show me how to read barcodes from an image in Python"
 - "Get the Python sample for video decoding"
 
+### Web Barcode Reader
+- "Create a web page that scans barcodes from a camera"
+- "Show me the web barcode reader hello world sample"
+- "Get the React sample for web barcode scanning"
+- "How do I decode barcodes from an image in JavaScript?"
+
 ### Dynamic Web TWAIN
 - "Create a web page that scans documents from a TWAIN scanner"
 - "Show me how to save scanned documents as PDF"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-dynamsoft-mcp",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "MCP server for Dynamsoft SDKs - Barcode Reader (Mobile/Python/Web) and Dynamic Web TWAIN. Provides documentation, code snippets, and API guidance.",
   "repository": {
     "type": "git",

package/src/index.js

@@ -216,6 +216,78 @@ function discoverPythonSamples() {
   return samples;
 }
 
+function discoverWebSamples() {
+  const categories = {
+    "root": [],
+    "frameworks": [],
+    "scenarios": []
+  };
+  const webPath = join(codeSnippetRoot, "dynamsoft-barcode-reader", "web");
+
+  if (!existsSync(webPath)) return categories;
+
+  // Find HTML files in root
+  for (const entry of readdirSync(webPath, { withFileTypes: true })) {
+    if (entry.isFile() && entry.name.endsWith(".html")) {
+      categories["root"].push(entry.name.replace(".html", ""));
+    }
+  }
+
+  // Find samples in subdirectories
+  for (const subdir of ["frameworks", "scenarios"]) {
+    const subdirPath = join(webPath, subdir);
+    if (existsSync(subdirPath)) {
+      for (const entry of readdirSync(subdirPath, { withFileTypes: true })) {
+        if (entry.isDirectory()) {
+          categories[subdir].push(entry.name);
+        } else if (entry.isFile() && entry.name.endsWith(".html")) {
+          categories[subdir].push(entry.name.replace(".html", ""));
+        }
+      }
+    }
+  }
+
+  // Remove empty categories
+  for (const [key, value] of Object.entries(categories)) {
+    if (value.length === 0) delete categories[key];
+  }
+
+  return categories;
+}
+
+function getWebSamplePath(category, sampleName) {
+  const webPath = join(codeSnippetRoot, "dynamsoft-barcode-reader", "web");
+
+  if (category === "root" || !category) {
+    // Try root level
+    const htmlPath = join(webPath, `${sampleName}.html`);
+    if (existsSync(htmlPath)) return htmlPath;
+  } else {
+    // Try in subdirectory
+    const dirPath = join(webPath, category, sampleName);
+    if (existsSync(dirPath) && statSync(dirPath).isDirectory()) {
+      // Look for index.html or main html file
+      const indexPath = join(dirPath, "index.html");
+      if (existsSync(indexPath)) return indexPath;
+      // Look for any html file
+      for (const entry of readdirSync(dirPath, { withFileTypes: true })) {
+        if (entry.isFile() && entry.name.endsWith(".html")) {
+          return join(dirPath, entry.name);
+        }
+      }
+    }
+    // Try as html file directly
+    const htmlPath = join(webPath, category, `${sampleName}.html`);
+    if (existsSync(htmlPath)) return htmlPath;
+  }
+
+  // Fallback: search all
+  const rootPath = join(webPath, `${sampleName}.html`);
+  if (existsSync(rootPath)) return rootPath;
+
+  return null;
+}
+
 function discoverDwtSamples() {
   const categories = {};
   const dwtPath = join(codeSnippetRoot, "dynamic-web-twain");
@@ -385,7 +457,9 @@ server.registerTool(
     lines.push("- `list_sdks` - List all SDKs");
     lines.push("- `get_sdk_info` - Get detailed SDK info for a platform");
     lines.push("- `list_samples` - List code samples (mobile)");
+    lines.push("- `list_web_samples` - List web barcode reader samples");
     lines.push("- `get_code_snippet` - Get actual source code");
+    lines.push("- `get_web_sample` - Get web barcode reader sample code");
     lines.push("- `get_quick_start` - Get complete working example");
     lines.push("- `get_gradle_config` - Get Android build config");
     lines.push("- `get_license_info` - Get license setup code");
@@ -581,6 +655,99 @@ server.registerTool(
   }
 );
 
+// ============================================================================
+// TOOL: list_web_samples
+// ============================================================================
+
+server.registerTool(
+  "list_web_samples",
+  {
+    title: "List Web Barcode Samples",
+    description: "List available JavaScript/Web barcode reader code samples",
+    inputSchema: {}
+  },
+  async () => {
+    const categories = discoverWebSamples();
+    const sdkEntry = registry.sdks["dbr-web"];
+
+    const lines = [
+      "# Web Barcode Reader Samples",
+      "",
+      `**SDK Version:** ${sdkEntry.version}`,
+      `**Install:** \`npm install dynamsoft-barcode-reader-bundle\``,
+      `**CDN:** \`${sdkEntry.platforms.web.installation.cdn}\``,
+      "",
+      "## Available Samples",
+      ""
+    ];
+
+    for (const [category, samples] of Object.entries(categories)) {
+      const categoryTitle = category === "root" ? "Basic Samples" : category.charAt(0).toUpperCase() + category.slice(1);
+      lines.push(`### ${categoryTitle}`);
+      lines.push(samples.map(s => `- ${s}`).join("\n"));
+      lines.push("");
+    }
+
+    lines.push("Use `get_web_sample` with sample_name to get code.");
+
+    return { content: [{ type: "text", text: lines.join("\n") }] };
+  }
+);
+
+// ============================================================================
+// TOOL: get_web_sample
+// ============================================================================
+
+server.registerTool(
+  "get_web_sample",
+  {
+    title: "Get Web Barcode Sample",
+    description: "Get JavaScript/Web barcode reader sample code",
+    inputSchema: {
+      sample_name: z.string().describe("Sample name, e.g. hello-world, read-an-image"),
+      category: z.string().optional().describe("Category: root, frameworks, scenarios (optional)")
+    }
+  },
+  async ({ sample_name, category }) => {
+    const samplePath = getWebSamplePath(category, sample_name);
+
+    if (!samplePath) {
+      const categories = discoverWebSamples();
+      const allSamples = Object.entries(categories)
+        .map(([cat, samples]) => samples.map(s => `${cat}/${s}`))
+        .flat();
+      return {
+        content: [{
+          type: "text",
+          text: `Sample "${sample_name}" not found.\n\nAvailable samples:\n${allSamples.map(s => `- ${s}`).join("\n")}\n\nUse \`list_web_samples\` to see all available samples.`
+        }]
+      };
+    }
+
+    const content = readCodeFile(samplePath);
+    if (!content) {
+      return { content: [{ type: "text", text: `Could not read "${sample_name}".` }] };
+    }
+
+    const sdkEntry = registry.sdks["dbr-web"];
+
+    const output = [
+      `# Web Barcode Reader: ${sample_name}`,
+      "",
+      `**SDK Version:** ${sdkEntry.version}`,
+      `**Install:** \`npm install dynamsoft-barcode-reader-bundle\``,
+      `**CDN:** \`${sdkEntry.platforms.web.installation.cdn}\``,
+      `**Trial License:** \`${registry.trial_license}\``,
+      "",
+      "```html",
+      content,
+      "```"
+    ];
+
+    return { content: [{ type: "text", text: output.join("\n") }] };
+  }
+);
+
 // ============================================================================
 // TOOL: list_dwt_categories
 // ============================================================================
@@ -1066,6 +1233,49 @@ server.registerTool(
       };
     }
 
+    // Handle Web Barcode Reader SDK
+    if (sdkId === "dbr-web") {
+      const sdkEntry = registry.sdks["dbr-web"];
+      const sampleName = use_case?.includes("image") ? "read-an-image" : "hello-world";
+      const samplePath = getWebSamplePath("root", sampleName);
+
+      if (!samplePath || !existsSync(samplePath)) {
+        return { content: [{ type: "text", text: `Sample not found. Use list_web_samples to see available.` }] };
+      }
+
+      const content = readCodeFile(samplePath);
+
+      return {
+        content: [{
+          type: "text", text: [
+            "# Quick Start: Web Barcode Reader",
+            "",
+            `**SDK Version:** ${sdkEntry.version}`,
+            `**Trial License:** \`${registry.trial_license}\``,
+            "",
+            "## Option 1: CDN",
+            "```html",
+            `<script src="${sdkEntry.platforms.web.installation.cdn}"></script>`,
+            "```",
+            "",
+            "## Option 2: NPM",
+            "```bash",
+            "npm install dynamsoft-barcode-reader-bundle",
+            "```",
+            "",
+            `## Sample: ${sampleName}.html`,
+            "```html",
+            content,
+            "```",
+            "",
+            "## Notes",
+            "- Trial license requires network connection",
+            `- User Guide: ${sdkEntry.platforms.web.docs["user-guide"]}`
+          ].join("\n")
+        }]
+      };
+    }
+
     // Handle Mobile SDK (original logic)
     const level = normalizeApiLevel(api_level);
     const platformKey = platform || "android";
@@ -1566,6 +1776,29 @@ for (const sampleName of pythonSamples) {
   );
 }
 
+// Register Web barcode reader sample resources
+const webCategories = discoverWebSamples();
+for (const [category, samples] of Object.entries(webCategories)) {
+  for (const sampleName of samples) {
+    const resourceUri = `dynamsoft://samples/web/${category}/${sampleName}`;
+    const resourceName = `web-${category}-${sampleName}`.toLowerCase().replace(/[^a-z0-9-]/g, "-");
+    server.registerResource(
+      resourceName,
+      resourceUri,
+      {
+        title: `Web: ${sampleName}`,
+        description: `Web barcode reader ${category}: ${sampleName}`,
+        mimeType: "text/html"
+      },
+      async (uri) => {
+        const samplePath = getWebSamplePath(category, sampleName);
+        const content = samplePath && existsSync(samplePath) ? readCodeFile(samplePath) : "Sample not found";
+        return { contents: [{ uri: uri.href, text: content, mimeType: "text/html" }] };
+      }
+    );
+  }
+}
+
 // Register DWT sample resources
 const dwtCategories = discoverDwtSamples();
 for (const [category, samples] of Object.entries(dwtCategories)) {

package/test/server.test.js

@@ -121,7 +121,7 @@ await test('Server responds to initialize request', async () => {
 });
 
 // Test 2: List tools
-await test('tools/list returns all 16 tools', async () => {
+await test('tools/list returns all 18 tools', async () => {
     const response = await sendRequest({
         jsonrpc: '2.0',
         id: 1,
@@ -130,15 +130,15 @@ await test('tools/list returns all 16 tools', async () => {
 
     assert(response.result, 'Should have result');
     assert(response.result.tools, 'Should have tools array');
-    assert(response.result.tools.length === 16, `Expected 16 tools, got ${response.result.tools.length}`);
+    assert(response.result.tools.length === 18, `Expected 18 tools, got ${response.result.tools.length}`);
 
     const toolNames = response.result.tools.map(t => t.name);
     const expectedTools = [
         'list_sdks', 'get_sdk_info', 'list_samples', 'list_python_samples',
-        'list_dwt_categories', 'get_code_snippet', 'get_python_sample',
-        'get_dwt_sample', 'get_quick_start', 'get_gradle_config',
-        'get_license_info', 'get_api_usage', 'search_samples', 'generate_project',
-        'search_dwt_docs', 'get_dwt_api_doc'
+        'list_web_samples', 'list_dwt_categories', 'get_code_snippet',
+        'get_web_sample', 'get_python_sample', 'get_dwt_sample', 'get_quick_start',
+        'get_gradle_config', 'get_license_info', 'get_api_usage', 'search_samples',
+        'generate_project', 'search_dwt_docs', 'get_dwt_api_doc'
     ];
 
     for (const expected of expectedTools) {
@@ -348,7 +348,43 @@ await test('generate_project returns project structure', async () => {
     assert(text.includes('AndroidManifest.xml') || text.includes('build.gradle'), 'Should include project files');
 });
 
-// Test 14: search_dwt_docs tool
+// Test 14: list_web_samples tool
+await test('list_web_samples returns web barcode samples', async () => {
+    const response = await sendRequest({
+        jsonrpc: '2.0',
+        id: 1,
+        method: 'tools/call',
+        params: {
+            name: 'list_web_samples',
+            arguments: {}
+        }
+    });
+
+    assert(response.result, 'Should have result');
+    assert(response.result.content, 'Should have content');
+    const text = response.result.content[0].text;
+    assert(text.includes('Web Barcode Reader Samples'), 'Should include web samples header');
+});
+
+// Test 15: get_web_sample tool
+await test('get_web_sample returns web barcode sample code', async () => {
+    const response = await sendRequest({
+        jsonrpc: '2.0',
+        id: 1,
+        method: 'tools/call',
+        params: {
+            name: 'get_web_sample',
+            arguments: { sample_name: 'hello-world' }
+        }
+    });
+
+    assert(response.result, 'Should have result');
+    assert(response.result.content, 'Should have content');
+    const text = response.result.content[0].text;
+    assert(text.includes('Web Barcode Reader') || text.includes('html') || text.includes('not found'), 'Should return sample or indicate not found');
+});
+
+// Test 16: search_dwt_docs tool
 await test('search_dwt_docs finds documentation articles', async () => {
     const response = await sendRequest({
         jsonrpc: '2.0',
@@ -367,7 +403,7 @@ await test('search_dwt_docs finds documentation articles', async () => {
     assert(text.includes('PDF') || text.includes('pdf'), 'Should find PDF-related articles');
 });
 
-// Test 15: get_dwt_api_doc tool
+// Test 17: get_dwt_api_doc tool
 await test('get_dwt_api_doc returns documentation article', async () => {
     const response = await sendRequest({
         jsonrpc: '2.0',
@@ -386,7 +422,7 @@ await test('get_dwt_api_doc returns documentation article', async () => {
     assert(text.includes('OCR') || text.includes('not found'), 'Should handle OCR query');
 });
 
-// Test 16: resources/list returns registered resources
+// Test 18: resources/list returns registered resources
 await test('resources/list returns registered resources', async () => {
     const response = await sendRequest({
         jsonrpc: '2.0',
@@ -404,7 +440,7 @@ await test('resources/list returns registered resources', async () => {
     assert(uris.some(u => u.includes('docs/dwt')), 'Should have DWT doc resources');
 });
 
-// Test 17: Invalid tool call returns error
+// Test 19: Invalid tool call returns error
 await test('Invalid tool call returns proper error', async () => {
     const response = await sendRequest({
         jsonrpc: '2.0',
@@ -420,7 +456,7 @@ await test('Invalid tool call returns proper error', async () => {
         'Should return error for invalid tool');
 });
 
-// Test 18: Tool with invalid arguments returns error
+// Test 20: Tool with invalid arguments returns error
 await test('Tool with missing required arguments returns error', async () => {
     const response = await sendRequest({
         jsonrpc: '2.0',