@docsector/docsector-reader 1.5.0 → 1.6.0

package/README.md

@@ -31,6 +31,7 @@ Transform Markdown content into beautiful, navigable documentation sites — wit
 - 🧭 **Content Signals** — Optional `Content-Signal` directive for declaring AI usage policy (`ai-train`, `search`, `ai-input`) in `robots.txt`
 - 🧩 **Agent Skills Discovery Index** — Optional `/.well-known/agent-skills/index.json` with RFC v0.2.0 schema and SHA-256 digests
 - 🪪 **MCP Server Card** — Optional `/.well-known/mcp/server-card.json` for MCP server discovery before connection
+- 🌐 **WebMCP Browser Tools** — Optional registration of in-page tools via `navigator.modelContext` for browser agents
 - 🔗 **Homepage Link Headers** — Auto-generated `Link` response headers for agent discovery (`api-catalog`, `service-doc`, `service-desc`, `describedby`) per RFC 8288 / RFC 9727
 - 🔌 **MCP Server** — Auto-generated [MCP](https://modelcontextprotocol.io) server at `/mcp` for AI assistant integration (Claude Desktop, VS Code, etc.)
 - 📄 **llms.txt / llms-full.txt** — Auto-generated [llms.txt](https://llmstxt.org) index and full-content file for LLM discovery (requires `siteUrl` in config)
@@ -46,6 +47,7 @@ Transform Markdown content into beautiful, navigable documentation sites — wit
 - 🌗 **Dark/Light Mode** — Automatic theme switching with Quasar Dark Plugin
 - 🔗 **Anchor Navigation** — Right-side Table of Contents tree with scroll tracking and auto-scroll to active section
 - 🔎 **Search** — Menu search across all documentation content and tags
+- 🌐 **WebMCP Browser Tools** — Registers in-page tools for browser agents with `registerTool` and optional `provideContext` fallback
 - 📱 **Responsive** — Mobile-friendly with collapsible sidebar and drawers
 - 🏷️ **Status Badges** — Mark pages as `done`, `draft`, or `empty` with visual indicators
 - ✏️ **Edit on GitHub** — Direct links to edit pages on your repository
@@ -205,6 +207,63 @@ Check `checks.discovery.mcpServerCard.status` equals `"pass"`.
 
 ---
 
+## 🌐 WebMCP Browser Tools
+
+Docsector Reader can register browser-side tools for agents when
+`navigator.modelContext` is available (secure context required).
+
+Default tools:
+
+- `docs.search_docs` (bridges to MCP `search_{toolSuffix}`)
+- `docs.get_page` (bridges to MCP `get_page_{toolSuffix}`)
+- `docs.navigate_to` (SPA navigation)
+- `docs.copy_current_page` (current page markdown URL/content)
+
+### WebMCP Configure
+
+```javascript
+export default {
+  // ...other config
+
+  mcp: {
+    serverName: 'my-docs',
+    toolSuffix: 'my_docs'
+  },
+
+  webMcp: {
+    enabled: true,
+    apiMode: 'dual', // 'registerTool' | 'dual'
+    toolPrefix: 'docs',
+    bridgeEndpoint: '/mcp',
+    bridgeToMcp: true,
+    tools: {
+      searchDocs: true,
+      getPage: true,
+      navigateTo: true,
+      copyCurrentPage: true
+    }
+  }
+}
+```
+
+Notes:
+
+- `apiMode: 'registerTool'` uses only `navigator.modelContext.registerTool()`.
+- `apiMode: 'dual'` also attempts `provideContext` fallback when available.
+- Registration happens on page load and is automatically cleaned up on unmount.
+
+### WebMCP Validate
+
+```bash
+curl -X POST https://isitagentready.com/api/scan \
+  -H 'Content-Type: application/json' \
+  -d '{"url":"https://YOUR-SITE.com"}'
+```
+
+Check `checks.discovery.webMcp.status` equals `"pass"`.
+
+---
+
 ## � llms.txt (LLM Discovery)
 
 Docsector Reader automatically generates [llms.txt](https://llmstxt.org) files at build time when `siteUrl` is configured (same requirement as sitemap.xml).

package/bin/docsector.js

@@ -23,7 +23,7 @@ const packageRoot = resolve(__dirname, '..')
 const args = process.argv.slice(2)
 const command = args[0]
 
-const VERSION = '1.5.0'
+const VERSION = '1.6.0'
 
 const HELP = `
   Docsector Reader v${VERSION}
@@ -148,6 +148,23 @@ export default {
   //   }
   // },
 
+  // @ WebMCP browser tools (optional)
+  // Registers tools in browser contexts that expose navigator.modelContext.
+  // Uses registerTool when available, with optional provideContext fallback.
+  // webMcp: {
+  //   enabled: true,
+  //   apiMode: 'dual', // 'registerTool' | 'dual'
+  //   toolPrefix: 'docs',
+  //   bridgeEndpoint: '/mcp',
+  //   bridgeToMcp: true,
+  //   tools: {
+  //     searchDocs: true,
+  //     getPage: true,
+  //     navigateTo: true,
+  //     copyCurrentPage: true
+  //   }
+  // },
+
   // @ Homepage Link headers for agent discovery (optional)
   // linkHeaders: {
   //   enabled: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docsector/docsector-reader",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "description": "A documentation rendering engine built with Vue 3, Quasar v2 and Vite. Transform Markdown into beautiful, navigable documentation sites.",
   "productName": "Docsector Reader",
   "author": "Rodrigo de Araujo Vieira",

package/src/App.vue

@@ -114,20 +114,24 @@
 </template>
 
 <script setup>
-import { reactive, computed, onMounted } from 'vue'
+import { reactive, computed, onMounted, onBeforeUnmount } from 'vue'
 import { useQuasar } from 'quasar'
 import { useStore } from 'vuex'
 import { useI18n } from 'vue-i18n'
-import { useRouter } from 'vue-router'
+import { useRouter, useRoute } from 'vue-router'
 
 import docsectorConfig from 'docsector.config.js'
+import { setupWebMcp } from './composables/useWebMcp'
 
 defineOptions({ name: 'App' })
 
 const $q = useQuasar()
 const store = useStore()
-const { locale } = useI18n()
+const { locale, t } = useI18n()
 const router = useRouter()
+const route = useRoute()
+
+let cleanupWebMcp = null
 
 const settings = reactive({
   general: {
@@ -213,6 +217,21 @@ onMounted(() => {
     settings.appearance.background.default = dark
   }
   $q.dark.set(dark)
+
+  cleanupWebMcp = setupWebMcp({
+    router,
+    route,
+    store,
+    translate: t,
+    locale
+  })
+})
+
+onBeforeUnmount(() => {
+  if (typeof cleanupWebMcp === 'function') {
+    cleanupWebMcp()
+    cleanupWebMcp = null
+  }
 })
 </script>
 

package/src/composables/useWebMcp.js

@@ -0,0 +1,398 @@
+import docsectorConfig from 'docsector.config.js'
+
+let activeCleanup = null
+
+function toSafeToolPrefix (prefix) {
+  const value = String(prefix || 'docs')
+    .trim()
+    .replace(/[^A-Za-z0-9_.-]/g, '_')
+
+  if (!value) {
+    return 'docs'
+  }
+
+  return value.slice(0, 48)
+}
+
+function decodeMarkdownSource (source) {
+  return String(source || '')
+    .replace(/{/g, '{')
+    .replace(/}/g, '}')
+    .replace(/\{'([^']+)'\}/g, '$1')
+    .replace(/&/g, '&')
+}
+
+function isSecurePageContext () {
+  if (typeof window === 'undefined') return false
+
+  if (window.isSecureContext) return true
+
+  const protocol = window.location?.protocol || ''
+  const host = window.location?.hostname || ''
+  return protocol === 'https:' || host === 'localhost' || host === '127.0.0.1'
+}
+
+function buildMcpEndpoint (bridgeEndpoint) {
+  if (typeof window === 'undefined') return '/mcp'
+
+  const endpoint = bridgeEndpoint || '/mcp'
+  try {
+    return new URL(endpoint, window.location.origin).toString()
+  } catch {
+    return `${window.location.origin}/mcp`
+  }
+}
+
+async function callMcpTool ({ endpoint, toolName, args }) {
+  const requestId = `${toolName}:${Date.now()}`
+  const response = await fetch(endpoint, {
+    method: 'POST',
+    headers: { 'Content-Type': 'application/json' },
+    body: JSON.stringify({
+      jsonrpc: '2.0',
+      id: requestId,
+      method: 'tools/call',
+      params: {
+        name: toolName,
+        arguments: args || {}
+      }
+    })
+  })
+
+  if (!response.ok) {
+    throw new Error(`MCP endpoint responded with ${response.status}`)
+  }
+
+  const payload = await response.json()
+  if (payload.error) {
+    throw new Error(payload.error.message || 'MCP tool call failed')
+  }
+
+  return payload.result || null
+}
+
+function normalizePath (inputPath) {
+  const value = String(inputPath || '').trim()
+  if (!value) return '/'
+
+  if (value.startsWith('http://') || value.startsWith('https://')) {
+    try {
+      const url = new URL(value)
+      return `${url.pathname}${url.search}${url.hash}`
+    } catch {
+      return '/'
+    }
+  }
+
+  if (value.startsWith('/')) {
+    return value
+  }
+
+  return `/${value}`
+}
+
+function createToolDefinitions ({
+  prefix,
+  mcpToolSuffix,
+  bridgeEndpoint,
+  bridgeToMcp,
+  tools,
+  router,
+  getCurrentPath,
+  getCurrentHash,
+  getLocale,
+  getAbsoluteI18nPath,
+  translate
+}) {
+  const endpoint = buildMcpEndpoint(bridgeEndpoint)
+
+  const maybeCallMcp = async (toolName, args) => {
+    if (!bridgeToMcp) {
+      throw new Error('MCP bridge disabled in webMcp configuration')
+    }
+
+    return callMcpTool({ endpoint, toolName, args })
+  }
+
+  const definitions = []
+
+  if (tools.searchDocs) {
+    definitions.push({
+      name: `${prefix}.search_docs`,
+      description: 'Search documentation pages by keyword and return top matches.',
+      inputSchema: {
+        type: 'object',
+        properties: {
+          query: {
+            type: 'string',
+            description: 'Search term or phrase.'
+          }
+        },
+        required: ['query']
+      },
+      annotations: { readOnlyHint: true },
+      execute: async (input) => {
+        const query = String(input?.query || '').trim()
+        if (!query) {
+          return {
+            ok: false,
+            error: 'Missing required field: query'
+          }
+        }
+
+        const toolName = `search_${mcpToolSuffix}`
+        const result = await maybeCallMcp(toolName, { query })
+
+        return {
+          ok: true,
+          query,
+          mcpTool: toolName,
+          endpoint,
+          result
+        }
+      }
+    })
+  }
+
+  if (tools.getPage) {
+    definitions.push({
+      name: `${prefix}.get_page`,
+      description: 'Fetch a documentation page in markdown format by its path.',
+      inputSchema: {
+        type: 'object',
+        properties: {
+          path: {
+            type: 'string',
+            description: 'Documentation page path without trailing .md.'
+          }
+        },
+        required: ['path']
+      },
+      annotations: { readOnlyHint: true },
+      execute: async (input) => {
+        const path = String(input?.path || '').trim()
+        if (!path) {
+          return {
+            ok: false,
+            error: 'Missing required field: path'
+          }
+        }
+
+        const toolName = `get_page_${mcpToolSuffix}`
+        const result = await maybeCallMcp(toolName, { path })
+
+        return {
+          ok: true,
+          path,
+          mcpTool: toolName,
+          endpoint,
+          result
+        }
+      }
+    })
+  }
+
+  if (tools.navigateTo) {
+    definitions.push({
+      name: `${prefix}.navigate_to`,
+      description: 'Navigate to a docs route and optional anchor hash in the current session.',
+      inputSchema: {
+        type: 'object',
+        properties: {
+          path: {
+            type: 'string',
+            description: 'Target path (absolute or relative).'
+          },
+          hash: {
+            type: 'string',
+            description: 'Optional hash fragment, with or without leading #.'
+          }
+        }
+      },
+      annotations: { readOnlyHint: false },
+      execute: async (input) => {
+        const path = normalizePath(input?.path || getCurrentPath())
+        const hashInput = String(input?.hash || '').trim()
+        const hash = hashInput ? (hashInput.startsWith('#') ? hashInput : `#${hashInput}`) : ''
+
+        await router.push({ path, hash })
+
+        return {
+          ok: true,
+          path,
+          hash,
+          currentPath: getCurrentPath(),
+          currentHash: getCurrentHash()
+        }
+      }
+    })
+  }
+
+  if (tools.copyCurrentPage) {
+    definitions.push({
+      name: `${prefix}.copy_current_page`,
+      description: 'Return markdown URL and markdown source for the current page context.',
+      inputSchema: {
+        type: 'object',
+        properties: {
+          includeContent: {
+            type: 'boolean',
+            description: 'When false, return metadata and URL only.'
+          }
+        }
+      },
+      annotations: { readOnlyHint: true },
+      execute: async (input) => {
+        const locale = getLocale() || 'en-US'
+        const currentPath = getCurrentPath()
+        const path = currentPath === '/' ? '/Homepage' : currentPath.replace(/\/+$/, '')
+        const markdownUrl = `${window.location.origin}${path}.md`
+
+        const includeContent = input?.includeContent !== false
+        const absolute = getAbsoluteI18nPath()
+
+        let content = ''
+        if (includeContent && absolute) {
+          const source = translate(`_.${absolute}.source`)
+          if (source) {
+            content = decodeMarkdownSource(source)
+          }
+        }
+
+        return {
+          ok: true,
+          locale,
+          path: currentPath,
+          markdownUrl,
+          content
+        }
+      }
+    })
+  }
+
+  return definitions
+}
+
+function registerWithProvideContext (modelContext, toolDefinitions) {
+  if (typeof modelContext.provideContext !== 'function') return null
+
+  const payload = {
+    tools: toolDefinitions.map((tool) => ({
+      name: tool.name,
+      description: tool.description,
+      inputSchema: tool.inputSchema,
+      execute: tool.execute
+    }))
+  }
+
+  const result = modelContext.provideContext(payload)
+
+  if (typeof result === 'function') {
+    return result
+  }
+
+  if (result && typeof result.dispose === 'function') {
+    return () => result.dispose()
+  }
+
+  if (result && typeof result.unregister === 'function') {
+    return () => result.unregister()
+  }
+
+  return null
+}
+
+export function setupWebMcp ({ router, route, store, translate, locale }) {
+  const webMcp = docsectorConfig.webMcp || {}
+  if (!webMcp.enabled) return () => {}
+
+  if (!isSecurePageContext()) return () => {}
+
+  const modelContext = navigator?.modelContext
+  if (!modelContext) return () => {}
+
+  if (activeCleanup) {
+    activeCleanup()
+    activeCleanup = null
+  }
+
+  const prefix = toSafeToolPrefix(webMcp.toolPrefix || 'docs')
+  const mcpToolSuffix = String(docsectorConfig.mcp?.toolSuffix || 'docs')
+    .replace(/[^A-Za-z0-9_]/g, '_')
+
+  const tools = {
+    searchDocs: webMcp.tools?.searchDocs !== false,
+    getPage: webMcp.tools?.getPage !== false,
+    navigateTo: webMcp.tools?.navigateTo !== false,
+    copyCurrentPage: webMcp.tools?.copyCurrentPage !== false
+  }
+
+  const definitions = createToolDefinitions({
+    prefix,
+    mcpToolSuffix,
+    bridgeEndpoint: webMcp.bridgeEndpoint || '/mcp',
+    bridgeToMcp: webMcp.bridgeToMcp !== false,
+    tools,
+    router,
+    getCurrentPath: () => route.path,
+    getCurrentHash: () => route.hash,
+    getLocale: () => locale.value,
+    getAbsoluteI18nPath: () => store?.state?.i18n?.absolute,
+    translate
+  })
+
+  if (definitions.length === 0) return () => {}
+
+  const supportsRegisterTool = typeof modelContext.registerTool === 'function'
+  const supportsProvideContext = typeof modelContext.provideContext === 'function'
+  const mode = webMcp.apiMode === 'registerTool' ? 'registerTool' : 'dual'
+
+  const abortController = new AbortController()
+  const cleanups = [() => abortController.abort()]
+
+  try {
+    if (supportsRegisterTool) {
+      for (const tool of definitions) {
+        modelContext.registerTool({
+          name: tool.name,
+          description: tool.description,
+          inputSchema: tool.inputSchema,
+          annotations: tool.annotations,
+          execute: tool.execute
+        }, { signal: abortController.signal })
+      }
+    } else if (mode === 'registerTool') {
+      return () => {}
+    }
+
+    if ((!supportsRegisterTool || mode === 'dual') && supportsProvideContext) {
+      const provideCleanup = registerWithProvideContext(modelContext, definitions)
+      if (provideCleanup) {
+        cleanups.push(provideCleanup)
+      }
+    }
+  } catch (error) {
+    if (import.meta.env?.DEV) {
+      console.warn('[docsector:webmcp] Failed to register tools', error)
+    }
+    return () => {}
+  }
+
+  const cleanup = () => {
+    while (cleanups.length > 0) {
+      const fn = cleanups.pop()
+      try {
+        fn()
+      } catch {
+        // Ignore cleanup errors
+      }
+    }
+  }
+
+  activeCleanup = cleanup
+  return cleanup
+}
+
+export default {
+  setupWebMcp
+}

package/src/index.js

@@ -87,6 +87,17 @@
  * @param {Object} [config.mcpServerCard.capabilities] - Optional capability overrides for tools/resources/prompts
  * @param {Array<Object>} [config.mcpServerCard.remotes=[]] - Optional additional remotes to include in the server card
  * @param {Object} [config.mcpServerCard.metadata] - Optional additional metadata merged into the server card payload
+ * @param {Object} [config.webMcp] - WebMCP browser tools settings
+ * @param {boolean} [config.webMcp.enabled=false] - Enables browser-side WebMCP tool registration on page load
+ * @param {'registerTool'|'dual'} [config.webMcp.apiMode='dual'] - Registration mode: registerTool only or registerTool + provideContext fallback
+ * @param {string} [config.webMcp.toolPrefix='docs'] - Prefix used to build WebMCP tool names (e.g. docs.search_docs)
+ * @param {string} [config.webMcp.bridgeEndpoint='/mcp'] - Relative endpoint used to bridge search/get_page to the MCP HTTP server
+ * @param {boolean} [config.webMcp.bridgeToMcp=true] - Uses MCP endpoint bridge for search/get_page tools when true
+ * @param {Object} [config.webMcp.tools] - Per-tool enable flags
+ * @param {boolean} [config.webMcp.tools.searchDocs=true] - Enables tool search_docs
+ * @param {boolean} [config.webMcp.tools.getPage=true] - Enables tool get_page
+ * @param {boolean} [config.webMcp.tools.navigateTo=true] - Enables tool navigate_to
+ * @param {boolean} [config.webMcp.tools.copyCurrentPage=true] - Enables tool copy_current_page
  * @returns {Object} Resolved Docsector configuration
  */
 export function createDocsector (config = {}) {
@@ -190,6 +201,22 @@ export function createDocsector (config = {}) {
       remotes: [],
       metadata: null,
       ...config.mcpServerCard
+    },
+
+    webMcp: {
+      enabled: false,
+      apiMode: 'dual',
+      toolPrefix: 'docs',
+      bridgeEndpoint: '/mcp',
+      bridgeToMcp: true,
+      ...config.webMcp,
+      tools: {
+        searchDocs: true,
+        getPage: true,
+        navigateTo: true,
+        copyCurrentPage: true,
+        ...(config.webMcp?.tools || {})
+      }
     }
   }
 }