@docsector/docsector-reader 0.12.3 → 0.13.0

package/README.md

@@ -26,6 +26,7 @@ Transform Markdown content into beautiful, navigable documentation sites — wit
 - 🤖 **LLM Bot Detection** — Automatically serves raw Markdown to known AI crawlers (GPTBot, ClaudeBot, PerplexityBot, GrokBot, and others)
 - 🗺️ **Sitemap Generation** — Automatic `sitemap.xml` generation at build time with all page URLs (requires `siteUrl` in config)
 - 🤖 **AI-Friendly robots.txt** — Scaffold includes a `robots.txt` explicitly allowing 23 AI crawlers (GPTBot, ClaudeBot, PerplexityBot, GrokBot, etc.)
+- 🔗 **Homepage Link Headers** — Auto-generated `Link` response headers for agent discovery (`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)
 
@@ -153,6 +154,56 @@ export default {
 
 ---
 
+## 🔗 Link Headers (Agent Discovery)
+
+Docsector Reader adds homepage `Link` response headers at build time for agent discovery, following [RFC 8288](https://www.rfc-editor.org/rfc/rfc8288) and [RFC 9727](https://www.rfc-editor.org/rfc/rfc9727#section-3).
+
+Default relations emitted on homepage (`/` and `/index.html`):
+
+- `rel="service-doc"` → `</>`
+- `rel="service-desc"` → `</mcp>` (only when `mcp` is enabled)
+- `rel="describedby"` → `</llms.txt>` (only when `siteUrl` is configured, i.e. `llms.txt` is generated)
+
+Generated in:
+
+- `dist/spa/_headers`
+
+### Optional configuration
+
+```javascript
+export default {
+  // ...other config
+
+  linkHeaders: {
+    enabled: true,
+    serviceDoc: '/',
+    serviceDesc: '/mcp',
+    describedBy: '/llms.txt'
+  }
+}
+```
+
+Set any target to `null` or `false` to disable that relation.
+
+### Validate
+
+```bash
+npx docsector build
+cat dist/spa/_headers
+```
+
+Or scan discoverability:
+
+```bash
+curl -X POST https://isitagentready.com/api/scan \
+  -H 'Content-Type: application/json' \
+  -d '{"url":"https://YOUR-SITE.com"}'
+```
+
+Check `checks.discoverability.linkHeaders.status` equals `"pass"`.
+
+---
+
 ## �🚀 Quick Start
 
 ### 📦 Install
@@ -288,6 +339,13 @@ export default {
     editBaseUrl: 'https://github.com/org/repo/edit/main/src/pages'
   },
 
+  linkHeaders: {
+    enabled: true,
+    serviceDoc: '/',
+    serviceDesc: '/mcp',
+    describedBy: '/llms.txt'
+  },
+
   languages: [
     { image: '/images/flags/united-states-of-america.png', label: 'English (US)', value: 'en-US' },
     { image: '/images/flags/brazil.png', label: 'Português (BR)', value: 'pt-BR' }

package/bin/docsector.js

@@ -23,7 +23,7 @@ const packageRoot = resolve(__dirname, '..')
 const args = process.argv.slice(2)
 const command = args[0]
 
-const VERSION = '0.12.3'
+const VERSION = '0.13.0'
 
 const HELP = `
   Docsector Reader v${VERSION}
@@ -133,6 +133,14 @@ export default {
   //   toolSuffix: 'my_docs'
   // },
 
+  // @ Homepage Link headers for agent discovery (optional)
+  // linkHeaders: {
+  //   enabled: true,
+  //   serviceDoc: '/',
+  //   serviceDesc: '/mcp',
+  //   describedBy: '/llms.txt'
+  // },
+
   // @ Languages
   languages: [
     {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docsector/docsector-reader",
-  "version": "0.12.3",
+  "version": "0.13.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

@@ -44,6 +44,11 @@
  * @param {Object} [config.mcp] - MCP (Model Context Protocol) server settings
  * @param {string} config.mcp.serverName - Server name for MCP identification (e.g. 'my-docs')
  * @param {string} config.mcp.toolSuffix - Suffix for tool names (e.g. 'my_docs' → search_my_docs)
+ * @param {Object} [config.linkHeaders] - Homepage Link headers for agent discovery
+ * @param {boolean} [config.linkHeaders.enabled=true] - Enables homepage Link headers generation
+ * @param {string|null|false} [config.linkHeaders.serviceDoc='/'] - Target URI for rel="service-doc"
+ * @param {string|null|false} [config.linkHeaders.serviceDesc='/mcp'] - Target URI for rel="service-desc" (only emitted when MCP is enabled)
+ * @param {string|null|false} [config.linkHeaders.describedBy='/llms.txt'] - Target URI for rel="describedby" (only emitted when llms.txt is generated)
  * @returns {Object} Resolved Docsector configuration
  */
 export function createDocsector (config = {}) {
@@ -83,7 +88,15 @@ export function createDocsector (config = {}) {
 
     defaultLanguage: config.defaultLanguage || 'en-US',
 
-    mcp: config.mcp || null
+    mcp: config.mcp || null,
+
+    linkHeaders: {
+      enabled: true,
+      serviceDoc: '/',
+      serviceDesc: '/mcp',
+      describedBy: '/llms.txt',
+      ...config.linkHeaders
+    }
   }
 }
 

package/src/quasar.factory.js

@@ -665,6 +665,52 @@ function createMarkdownBuildPlugin (projectRoot) {
       }
       console.log(`\x1b[36m[docsector]\x1b[0m Added _headers rule for .md files`)
 
+      // Add homepage Link headers for agent discovery (RFC 8288 / RFC 9727)
+      const linkHeadersConfig = config.linkHeaders || {}
+      const linkHeadersEnabled = linkHeadersConfig.enabled !== false
+
+      if (linkHeadersEnabled) {
+        const homepageLinks = []
+
+        const serviceDocHref = linkHeadersConfig.serviceDoc === undefined
+          ? '/'
+          : linkHeadersConfig.serviceDoc
+        if (serviceDocHref) {
+          homepageLinks.push({ rel: 'service-doc', href: serviceDocHref })
+        }
+
+        const serviceDescHref = linkHeadersConfig.serviceDesc === undefined
+          ? '/mcp'
+          : linkHeadersConfig.serviceDesc
+        if (config.mcp && serviceDescHref) {
+          homepageLinks.push({ rel: 'service-desc', href: serviceDescHref })
+        }
+
+        const describedByHref = linkHeadersConfig.describedBy === undefined
+          ? '/llms.txt'
+          : linkHeadersConfig.describedBy
+        if (siteUrl && describedByHref) {
+          homepageLinks.push({ rel: 'describedby', href: describedByHref })
+        }
+
+        if (homepageLinks.length > 0) {
+          const linkLines = homepageLinks.map(({ rel, href }) => `  Link: <${href}>; rel="${rel}"`).join('\n')
+          const homepageRule = ['/','/index.html']
+            .map(path => `${path}\n${linkLines}`)
+            .join('\n\n') + '\n'
+
+          const currentHeaders = readFileSync(headersPath, 'utf-8')
+          const hasAgentLinks = currentHeaders.includes('rel="service-doc"')
+            || currentHeaders.includes('rel="service-desc"')
+            || currentHeaders.includes('rel="describedby"')
+
+          if (!hasAgentLinks) {
+            writeFileSync(headersPath, currentHeaders.trimEnd() + '\n\n' + homepageRule)
+            console.log(`\x1b[36m[docsector]\x1b[0m Added homepage Link headers for agent discovery`)
+          }
+        }
+      }
+
       // Generate MCP server if configured
       if (config.mcp) {
         const mcpConfig = config.mcp