@docsector/docsector-reader 1.4.0 → 1.5.0

package/README.md

@@ -30,6 +30,7 @@ Transform Markdown content into beautiful, navigable documentation sites — wit
 - 🤖 **AI-Friendly robots.txt** — Scaffold includes a `robots.txt` explicitly allowing 23 AI crawlers (GPTBot, ClaudeBot, PerplexityBot, GrokBot, etc.)
 - 🧭 **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
 - 🔗 **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)
@@ -141,6 +142,69 @@ curl -X POST http://localhost:8788/mcp \
 
 ---
 
+## 🪪 MCP Server Card Discovery
+
+Docsector Reader can publish an MCP Server Card at:
+
+- `/.well-known/mcp/server-card.json`
+
+This supports pre-connection MCP discovery, exposing:
+
+- `serverInfo` (`name`, `version`)
+- MCP transport endpoint (defaults to `/mcp`)
+- `capabilities` for tools/resources/prompts
+
+When MCP is enabled, tool capabilities are derived from the generated server:
+
+- `search_{toolSuffix}`
+- `get_page_{toolSuffix}`
+
+### Configure
+
+```javascript
+export default {
+  // ...other config
+
+  mcp: {
+    serverName: 'my-docs',
+    toolSuffix: 'my_docs'
+  },
+
+  mcpServerCard: {
+    enabled: true,
+    path: '/.well-known/mcp/server-card.json',
+    transportEndpoint: '/mcp',
+    transportType: 'streamable-http',
+    protocolVersion: '2025-03-26',
+    capabilities: {
+      tools: { supported: true },
+      resources: { supported: false },
+      prompts: { supported: false }
+    }
+  }
+}
+```
+
+### Validate
+
+```bash
+npx docsector build
+cat dist/spa/.well-known/mcp/server-card.json
+cat dist/spa/_headers
+```
+
+External validation:
+
+```bash
+curl -X POST https://isitagentready.com/api/scan \
+  -H 'Content-Type: application/json' \
+  -d '{"url":"https://YOUR-SITE.com"}'
+```
+
+Check `checks.discovery.mcpServerCard.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).
@@ -550,6 +614,14 @@ export default {
     agentFallback: true
   },
 
+  mcpServerCard: {
+    enabled: true,
+    path: '/.well-known/mcp/server-card.json',
+    transportEndpoint: '/mcp',
+    transportType: 'streamable-http',
+    protocolVersion: '2025-03-26'
+  },
+
   contentSignals: {
     enabled: true,
     aiTrain: 'yes',

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.4.0'
+const VERSION = '1.5.0'
 
 const HELP = `
   Docsector Reader v${VERSION}
@@ -133,6 +133,21 @@ export default {
   //   toolSuffix: 'my_docs'
   // },
 
+  // @ MCP Server Card discovery (optional)
+  // Publishes /.well-known/mcp/server-card.json for pre-connection discovery.
+  // mcpServerCard: {
+  //   enabled: true,
+  //   path: '/.well-known/mcp/server-card.json',
+  //   transportEndpoint: '/mcp',
+  //   transportType: 'streamable-http',
+  //   protocolVersion: '2025-03-26',
+  //   capabilities: {
+  //     tools: { supported: true },
+  //     resources: { supported: false },
+  //     prompts: { supported: false }
+  //   }
+  // },
+
   // @ Homepage Link headers for agent discovery (optional)
   // linkHeaders: {
   //   enabled: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docsector/docsector-reader",
-  "version": "1.4.0",
+  "version": "1.5.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/index.js

@@ -78,6 +78,15 @@
  * @param {string} [config.agentSkills.path='/.well-known/agent-skills/index.json'] - Output URI path for Agent Skills index
  * @param {string} [config.agentSkills.schema='https://schemas.agentskills.io/discovery/0.2.0/schema.json'] - JSON Schema identifier for index payload
  * @param {Array<{name:string,type:'skill-md'|'archive',description:string,url:string,digest?:string}>} [config.agentSkills.skills=[]] - Skills to publish in discovery index
+ * @param {Object} [config.mcpServerCard] - MCP Server Card discovery settings
+ * @param {boolean} [config.mcpServerCard.enabled=false] - Enables generation of MCP Server Card discovery document
+ * @param {string} [config.mcpServerCard.path='/.well-known/mcp/server-card.json'] - Output URI path for MCP Server Card
+ * @param {string} [config.mcpServerCard.transportEndpoint='/mcp'] - MCP transport endpoint exposed by the server
+ * @param {string} [config.mcpServerCard.transportType='streamable-http'] - Transport type label for discovery metadata
+ * @param {string} [config.mcpServerCard.protocolVersion='2025-03-26'] - Protocol version advertised by the server card
+ * @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
  * @returns {Object} Resolved Docsector configuration
  */
 export function createDocsector (config = {}) {
@@ -169,6 +178,18 @@ export function createDocsector (config = {}) {
       schema: 'https://schemas.agentskills.io/discovery/0.2.0/schema.json',
       skills: [],
       ...config.agentSkills
+    },
+
+    mcpServerCard: {
+      enabled: false,
+      path: '/.well-known/mcp/server-card.json',
+      transportEndpoint: '/mcp',
+      transportType: 'streamable-http',
+      protocolVersion: '2025-03-26',
+      capabilities: null,
+      remotes: [],
+      metadata: null,
+      ...config.mcpServerCard
     }
   }
 }

package/src/quasar.factory.js

@@ -757,6 +757,8 @@ function createMarkdownBuildPlugin (projectRoot) {
       const contentSignalsEnabled = contentSignalsConfig.enabled === true
       const agentSkillsConfig = config.agentSkills || {}
       const agentSkillsEnabled = agentSkillsConfig.enabled === true
+      const mcpServerCardConfig = config.mcpServerCard || {}
+      const mcpServerCardEnabled = mcpServerCardConfig.enabled === true
 
       const toUrl = (href) => {
         if (!href) return null
@@ -1112,6 +1114,54 @@ export async function onRequest (context) {
         }
       }
 
+      if (mcpServerCardEnabled) {
+        if (!config.mcp) {
+          console.warn('\x1b[33m[docsector]\x1b[0m Skipped MCP Server Card generation: mcp config is not enabled')
+        } else {
+          const mcpServerCardPath = mcpServerCardConfig.path || '/.well-known/mcp/server-card.json'
+          const cardDistPath = normalizeLocalPath(mcpServerCardPath)
+
+          if (!cardDistPath) {
+            console.warn(`\x1b[33m[docsector]\x1b[0m Skipped MCP Server Card generation: path must be a local URI path, got "${mcpServerCardPath}"`)
+          } else {
+            const cardHref = mcpServerCardPath.startsWith('/') ? mcpServerCardPath : `/${mcpServerCardPath}`
+            const mcpServerName = config.mcp.serverName || config.branding?.name || 'docs'
+            const mcpServerVersion = config.branding?.version || '1.0.0'
+            const mcpToolSuffix = config.mcp.toolSuffix || 'docs'
+            const transportEndpoint = mcpServerCardConfig.transportEndpoint || '/mcp'
+            const endpoint = toUrl(transportEndpoint)
+
+            if (!endpoint) {
+              console.warn('\x1b[33m[docsector]\x1b[0m Skipped MCP Server Card generation: unable to resolve transport endpoint URL')
+            } else {
+              const cardPayload = buildMcpServerCardPayload({
+                config,
+                mcpServerCardConfig,
+                serverName: mcpServerName,
+                serverVersion: mcpServerVersion,
+                endpoint,
+                toolSuffix: mcpToolSuffix
+              })
+
+              const cardDir = resolve(distDir, cardDistPath, '..')
+              mkdirSync(cardDir, { recursive: true })
+              writeFileSync(
+                resolve(distDir, cardDistPath),
+                JSON.stringify(cardPayload, null, 2) + '\n'
+              )
+              console.log(`\x1b[36m[docsector]\x1b[0m Generated ${cardHref}`)
+
+              const headersWithServerCard = readFileSync(headersPath, 'utf-8')
+              if (!headersWithServerCard.includes(cardHref)) {
+                const serverCardHeaders = `${cardHref}\n  Content-Type: application/json; charset=utf-8\n`
+                writeFileSync(headersPath, headersWithServerCard.trimEnd() + '\n\n' + serverCardHeaders)
+                console.log(`\x1b[36m[docsector]\x1b[0m Added _headers rule for ${cardHref}`)
+              }
+            }
+          }
+        }
+      }
+
       console.log(`\x1b[36m[docsector]\x1b[0m Added _headers rule for .md files`)
 
       // Add homepage Link headers for agent discovery (RFC 8288 / RFC 9727)
@@ -1504,6 +1554,87 @@ function resolveAgentSkillArtifactPath (artifactUrl, { siteUrl, distDir }) {
   return resolve(distDir, relativePath)
 }
 
+function mergeObjects (base, override) {
+  if (!override || typeof override !== 'object' || Array.isArray(override)) {
+    return base
+  }
+
+  return { ...base, ...override }
+}
+
+function buildMcpServerCardPayload ({
+  config,
+  mcpServerCardConfig,
+  serverName,
+  serverVersion,
+  endpoint,
+  toolSuffix
+}) {
+  const transportType = mcpServerCardConfig.transportType || 'streamable-http'
+  const protocolVersion = mcpServerCardConfig.protocolVersion || '2025-03-26'
+  const baseTools = [
+    `search_${toolSuffix}`,
+    `get_page_${toolSuffix}`
+  ]
+
+  const defaultCapabilities = {
+    tools: {
+      supported: true,
+      names: baseTools
+    },
+    resources: {
+      supported: false
+    },
+    prompts: {
+      supported: false
+    }
+  }
+
+  const capabilitiesOverride = (mcpServerCardConfig.capabilities && typeof mcpServerCardConfig.capabilities === 'object' && !Array.isArray(mcpServerCardConfig.capabilities))
+    ? mcpServerCardConfig.capabilities
+    : {}
+  const capabilities = {
+    ...capabilitiesOverride,
+    tools: mergeObjects(defaultCapabilities.tools, capabilitiesOverride.tools),
+    resources: mergeObjects(defaultCapabilities.resources, capabilitiesOverride.resources),
+    prompts: mergeObjects(defaultCapabilities.prompts, capabilitiesOverride.prompts)
+  }
+
+  const primaryRemote = {
+    transportType,
+    endpoint,
+    supportedProtocolVersions: [protocolVersion]
+  }
+
+  const customRemotes = Array.isArray(mcpServerCardConfig.remotes)
+    ? mcpServerCardConfig.remotes
+    : []
+  const remotes = [primaryRemote, ...customRemotes]
+
+  const payload = {
+    serverInfo: {
+      name: serverName,
+      version: serverVersion
+    },
+    title: config.branding?.name || serverName,
+    description: config.branding?.description || null,
+    transport: {
+      type: transportType,
+      endpoint
+    },
+    remotes,
+    capabilities,
+    tools: baseTools.map(name => ({ name }))
+  }
+
+  const metadata = mcpServerCardConfig.metadata
+  if (metadata && typeof metadata === 'object' && !Array.isArray(metadata)) {
+    return { ...payload, ...metadata }
+  }
+
+  return payload
+}
+
 /**
  * Create a complete Quasar configuration for a docsector-reader consumer project.
  *