@farming-labs/docs 0.2.61 → 0.2.62

package/dist/mcp-DyPcoLwm.mjs

@@ -1,156 +0,0 @@
-import "./agent-Fl0pjVNF.mjs";
-import { k as resolveDocsPublishedAgentSkill } from "./standards-discovery-C54V_aJH.mjs";
-import "./search-9OnMGMvt.mjs";
-import "./sitemap-server-D_0Kzanj.mjs";
-import "./agent-evals-f4_OL10T.mjs";
-import { createFilesystemDocsMcpSource, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
-import "./code-blocks-DnNVNK2M.mjs";
-import { t as resolveConfiguredAgentSkills } from "./agent-skills-server-CIeBszxp.mjs";
-import "./server.mjs";
-import { _ as resolveDocsContentDir, d as readNavTitle, g as resolveDocsConfigPath, i as hasTopLevelProperty, l as readBooleanProperty, n as extractObjectLiteral, o as loadDocsConfigModuleResult, p as readStringProperty, t as extractNestedObjectLiteral } from "./config-Wcdj-D0a.mjs";
-import { existsSync, readFileSync } from "node:fs";
-import path from "node:path";
-import pc from "picocolors";
-
-//#region src/cli/mcp.ts
-const HOSTED_MCP_CLIENTS = [
-	"claude-code",
-	"cursor",
-	"vscode"
-];
-const HOSTED_MCP_CLIENT_LABELS = {
-	"claude-code": "Claude Code",
-	cursor: "Cursor",
-	vscode: "VS Code"
-};
-async function runMcp(options = {}) {
-	if (options.setup) {
-		printHostedMcpSetup(options);
-		return;
-	}
-	const rootDir = process.cwd();
-	const content = readFileSync(resolveDocsConfigPath(rootDir, options.configPath), "utf-8");
-	const configLoad = await loadDocsConfigModuleResult(rootDir, options.configPath);
-	const loadedConfig = configLoad.status === "evaluated" ? configLoad.config : void 0;
-	const staticAgent = extractNestedObjectLiteral(content, ["agent"]);
-	if (configLoad.status === "static-fallback" && staticAgent && hasTopLevelProperty(staticAgent, "skills")) throw new Error(`Could not evaluate ${configLoad.path}, so configured agent.skills cannot be published through MCP. ${configLoad.error}`);
-	const entry = readStringProperty(content, "entry") ?? "docs";
-	const contentDir = resolveDocsContentDir(rootDir, content, entry);
-	const navTitle = readNavTitle(content);
-	const mcp = readMcpConfig(content);
-	const filesystemSource = createFilesystemDocsMcpSource({
-		rootDir,
-		entry,
-		contentDir,
-		siteTitle: navTitle ?? "Documentation"
-	});
-	const resolvedMcp = resolveDocsMcpConfig(mcp ?? true, { defaultName: navTitle ?? "@farming-labs/docs" });
-	await runDocsMcpStdio({
-		source: {
-			...filesystemSource,
-			async getSkills() {
-				const configured = await resolveConfiguredAgentSkills(loadedConfig?.agent?.skills, { rootDir });
-				const rootSkillPath = path.join(rootDir, "skill.md");
-				return [await resolveDocsPublishedAgentSkill({
-					preferredDocument: existsSync(rootSkillPath) ? readFileSync(rootSkillPath, "utf8") : null,
-					fallbackDocument: `---\nname: docs\ndescription: Use the project documentation through MCP resources and tools.\n---\n\n# Documentation\n`
-				}), ...configured];
-			}
-		},
-		mcp: resolvedMcp,
-		defaultName: navTitle ?? "@farming-labs/docs"
-	});
-}
-function normalizeApiBaseUrl(value) {
-	return (value?.trim() || "https://api.farming-labs.dev").replace(/\/+$/g, "");
-}
-function normalizeHostedMcpClient(value) {
-	const normalized = value?.trim().toLowerCase() || "claude-code";
-	if (normalized === "claude") return "claude-code";
-	if (HOSTED_MCP_CLIENTS.includes(normalized)) return normalized;
-	throw new Error(`Unsupported MCP client "${value}". Expected one of: ${HOSTED_MCP_CLIENTS.join(", ")}.`);
-}
-function createHostedMcpClientConfig(deploymentId, apiBaseUrl, clientName) {
-	const endpoint = `${normalizeApiBaseUrl(apiBaseUrl)}/v1/mcp/${deploymentId.trim()}`;
-	const client = normalizeHostedMcpClient(clientName);
-	if (client === "cursor") return { mcpServers: { "docs-cloud": {
-		url: endpoint,
-		headers: { Authorization: "Bearer ${env:DOCS_CLOUD_API_KEY}" }
-	} } };
-	if (client === "vscode") return {
-		inputs: [{
-			type: "promptString",
-			id: "docs-cloud-api-key",
-			description: "Docs Cloud API key",
-			password: true
-		}],
-		servers: { "docs-cloud": {
-			type: "http",
-			url: endpoint,
-			headers: { Authorization: "Bearer ${input:docs-cloud-api-key}" }
-		} }
-	};
-	return { mcpServers: { "docs-cloud": {
-		type: "http",
-		url: endpoint,
-		headers: { Authorization: "Bearer ${DOCS_CLOUD_API_KEY}" }
-	} } };
-}
-function printHostedMcpSetup(options) {
-	const deploymentId = options.deploymentId?.trim();
-	if (!deploymentId) {
-		console.error(pc.red("Missing MCP deployment id."));
-		console.error();
-		console.error(`Run ${pc.cyan("npx @farming-labs/docs mcp setup --deployment <deployment-id>")}.`);
-		process.exit(1);
-	}
-	const client = normalizeHostedMcpClient(options.client);
-	const jsonConfig = createHostedMcpClientConfig(deploymentId, options.apiBaseUrl, client);
-	const endpoint = `${normalizeApiBaseUrl(options.apiBaseUrl)}/v1/mcp/${deploymentId}`;
-	if (options.json) {
-		console.log(JSON.stringify(jsonConfig, null, 2));
-		return;
-	}
-	console.log(pc.bold("Docs Cloud MCP deployment"));
-	console.log(pc.dim(`Deployment: ${deploymentId}`));
-	console.log();
-	console.log(pc.cyan("Streamable HTTP (recommended)"));
-	console.log(`  ${endpoint}`);
-	console.log();
-	console.log(pc.cyan("SSE"));
-	console.log(`  ${endpoint}/sse`);
-	console.log();
-	console.log(pc.cyan(`MCP client JSON (${HOSTED_MCP_CLIENT_LABELS[client]})`));
-	console.log(JSON.stringify(jsonConfig, null, 2));
-	console.log();
-	if (client === "vscode") console.log(pc.dim("VS Code prompts for the API key once and stores it securely."));
-	else console.log(pc.dim("The config reads DOCS_CLOUD_API_KEY from the MCP client environment; no secret is embedded."));
-	console.log(pc.dim("Use --client cursor or --client vscode to emit another native format."));
-}
-function readMcpConfig(content) {
-	if (content.match(/mcp\s*:\s*false/)) return false;
-	if (content.match(/mcp\s*:\s*true/)) return true;
-	const block = extractObjectLiteral(content, "mcp");
-	if (!block) return void 0;
-	return {
-		enabled: readBooleanProperty(block, "enabled"),
-		route: readStringProperty(block, "route"),
-		name: readStringProperty(block, "name"),
-		version: readStringProperty(block, "version"),
-		tools: {
-			listDocs: readBooleanProperty(block, "listDocs"),
-			listPages: readBooleanProperty(block, "listPages"),
-			listTasks: readBooleanProperty(block, "listTasks"),
-			readTask: readBooleanProperty(block, "readTask"),
-			readPage: readBooleanProperty(block, "readPage"),
-			searchDocs: readBooleanProperty(block, "searchDocs"),
-			getNavigation: readBooleanProperty(block, "getNavigation"),
-			getCodeExamples: readBooleanProperty(block, "getCodeExamples"),
-			getConfigSchema: readBooleanProperty(block, "getConfigSchema"),
-			getContext: readBooleanProperty(block, "getContext")
-		}
-	};
-}
-
-//#endregion
-export { runMcp };

package/dist/mcp.d.mts

@@ -1,298 +0,0 @@
-import { A as DocsPublishedAgentSkill } from "./standards-discovery-C4HUqMd2.mjs";
-import { Dt as DocsObservabilityConfig, En as PageAgentFrontmatter, Qt as DocsTelemetryConfig, R as DocsAnalyticsConfig, Ut as DocsSearchConfig, Yt as DocsSearchSourcePage, gt as DocsMcpAuthenticate, ht as DocsMcpAuthPrincipal, mt as DocsMcpAllowedOrigins, rn as DocsTelemetryFramework, xn as OrderingItem, yt as DocsMcpConfig } from "./types-EhFhYGfr.mjs";
-import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-
-//#region src/mcp.d.ts
-interface DocsMcpPage {
-  slug: string;
-  url: string;
-  title: string;
-  description?: string;
-  related?: DocsSearchSourcePage["related"];
-  agent?: PageAgentFrontmatter;
-  icon?: string;
-  sourcePath?: string;
-  lastModified?: string;
-  locale?: string;
-  framework?: string;
-  version?: string;
-  tags?: string[];
-  content: string;
-  rawContent?: string;
-  agentContent?: string;
-  agentRawContent?: string;
-  agentFallbackContent?: string;
-  agentFallbackRawContent?: string;
-}
-interface DocsMcpCodeExample {
-  id: string;
-  page: {
-    slug: string;
-    url: string;
-    title: string;
-    description?: string;
-    sourcePath?: string;
-    lastModified?: string;
-  };
-  language?: string;
-  title?: string;
-  framework?: string;
-  packageManager?: string;
-  runnable: boolean;
-  meta: Record<string, string | boolean>;
-  code: string;
-}
-interface DocsMcpDocsPageSummary {
-  slug: string;
-  url: string;
-  title: string;
-  description?: string;
-  agent?: DocsMcpAgentContractSummary;
-  icon?: string;
-  sourcePath?: string;
-  lastModified?: string;
-}
-interface DocsMcpAgentContractSummary {
-  hasContract: boolean;
-  task?: string;
-  outcome?: string;
-  appliesTo?: PageAgentFrontmatter["appliesTo"];
-}
-interface DocsMcpTaskSummary {
-  slug: string;
-  url: string;
-  title: string;
-  description?: string;
-  task?: string;
-  outcome?: string;
-  appliesTo?: PageAgentFrontmatter["appliesTo"];
-}
-interface DocsMcpDocsSection {
-  slug: string;
-  title: string;
-  url?: string;
-  description?: string;
-  icon?: string;
-  pageCount: number;
-  pages: DocsMcpDocsPageSummary[];
-  sections: DocsMcpDocsSection[];
-}
-interface DocsMcpDocsList {
-  section?: string;
-  resultCount: number;
-  sectionCount: number;
-  pages: DocsMcpDocsPageSummary[];
-  rootPages: DocsMcpDocsPageSummary[];
-  sections: DocsMcpDocsSection[];
-}
-interface DocsMcpConfigSchemaOption {
-  path: string;
-  name: string;
-  type: string;
-  default?: string | boolean | number | null;
-  description: string;
-  docs?: string;
-  values?: readonly string[];
-  children?: readonly DocsMcpConfigSchemaOption[];
-}
-interface DocsMcpConfigSchema {
-  schemaVersion: 1;
-  configFile: "docs.config.ts";
-  description: string;
-  filters?: {
-    option?: string;
-    query?: string;
-  };
-  resultCount: number;
-  options: DocsMcpConfigSchemaOption[];
-  examples: Array<{
-    title: string;
-    code: string;
-  }>;
-}
-interface DocsMcpContextSource {
-  id: string;
-  title: string;
-  /** Page URL without a fragment. */
-  pageUrl: string;
-  /** Source URL for this exact context chunk, including its heading anchor when available. */
-  url: string;
-  section?: string;
-  anchor?: string;
-  sourcePath?: string;
-  lastModified?: string;
-  locale?: string;
-  framework?: string;
-  version?: string;
-  tags?: string[];
-  score?: number;
-  content: string;
-  /** JavaScript string length for this source's content only. */
-  chars: number;
-  /** Encoded UTF-8 bytes for this source's content only. */
-  utf8Bytes: number;
-  truncated: boolean;
-}
-interface DocsMcpContextResult {
-  query: string;
-  filters: {
-    framework?: string;
-    version?: string;
-    locale?: string;
-  };
-  budget: {
-    /** Caller-provided token target; retained as the stable input contract. */requestedTokens: number; /** Dependency-free conservative accounting strategy. */
-    strategy: "utf8-bytes"; /** Hard UTF-8 byte ceiling for the complete assembled `context`. */
-    maxUtf8Bytes: number; /** Exact UTF-8 bytes used by the complete assembled `context`. */
-    usedUtf8Bytes: number; /** Conservative token-count upper bound derived from `usedUtf8Bytes`. */
-    conservativeTokenUpperBound: number;
-    remainingUtf8Bytes: number;
-    truncated: boolean;
-  };
-  resultCount: number;
-  candidateCount: number;
-  context: string;
-  sources: DocsMcpContextSource[];
-}
-interface DocsMcpContextOptions {
-  pages: readonly DocsMcpPage[];
-  query: string;
-  framework?: string;
-  version?: string;
-  locale?: string;
-  tokenBudget: number;
-  entry?: string;
-  siteTitle?: string;
-  /** Maximum number of ranked, deduplicated candidates to render. Defaults to 50. */
-  maxResults?: number;
-}
-interface DocsMcpPageNode {
-  type: "page";
-  name: string;
-  url: string;
-  icon?: string;
-  description?: string;
-}
-interface DocsMcpFolderNode {
-  type: "folder";
-  name: string;
-  icon?: string;
-  index?: DocsMcpPageNode;
-  children: DocsMcpNavigationNode[];
-}
-type DocsMcpNavigationNode = DocsMcpPageNode | DocsMcpFolderNode;
-interface DocsMcpNavigationTree {
-  name: string;
-  children: DocsMcpNavigationNode[];
-}
-interface DocsMcpSource {
-  entry?: string;
-  siteTitle?: string;
-  getPages(locale?: string, context?: DocsMcpRequestContext): DocsMcpPage[] | Promise<DocsMcpPage[]>;
-  getNavigation(locale?: string, context?: DocsMcpRequestContext): DocsMcpNavigationTree | Promise<DocsMcpNavigationTree>;
-  /** Reusable Agent Skills exposed as progressive-disclosure MCP resources. */
-  getSkills?(context?: DocsMcpRequestContext): readonly DocsPublishedAgentSkill[] | Promise<readonly DocsPublishedAgentSkill[]>;
-}
-/** Request-scoped identity available to custom MCP sources. */
-interface DocsMcpRequestContext {
-  transport: "http" | "stdio";
-  request?: Request;
-  auth?: DocsMcpAuthPrincipal;
-}
-interface DocsMcpResolvedSecurityConfig {
-  allowedOrigins: DocsMcpAllowedOrigins;
-  authenticate?: DocsMcpAuthenticate;
-  protectedResource?: DocsMcpResolvedProtectedResourceConfig;
-  maxBodyBytes: number;
-  cors: DocsMcpResolvedCorsConfig;
-}
-interface DocsMcpResolvedProtectedResourceConfig {
-  authorizationServers: string[];
-  scopesSupported: string[];
-  requiredScopes: string[];
-  resourceName?: string;
-  resourceDocumentation?: string;
-}
-interface DocsMcpResolvedCorsConfig {
-  enabled: boolean;
-  allowedHeaders: string[];
-  exposedHeaders: string[];
-  allowCredentials: boolean;
-  maxAgeSeconds: number;
-}
-interface DocsMcpResolvedConfig {
-  enabled: boolean;
-  route: string;
-  name: string;
-  version: string;
-  tools: {
-    listDocs: boolean;
-    listPages: boolean;
-    readPage: boolean;
-    listTasks?: boolean;
-    readTask?: boolean;
-    searchDocs: boolean;
-    getNavigation: boolean;
-    getCodeExamples: boolean;
-    getConfigSchema: boolean;
-    getContext: boolean;
-  };
-  /** Resolved HTTP-only security policy. Omitted on manually constructed legacy values. */
-  security?: DocsMcpResolvedSecurityConfig;
-}
-interface DocsMcpHttpHandlers {
-  GET: (context: {
-    request: Request;
-  }) => Promise<Response>;
-  POST: (context: {
-    request: Request;
-  }) => Promise<Response>;
-  DELETE: (context: {
-    request: Request;
-  }) => Promise<Response>;
-  OPTIONS: (context: {
-    request: Request;
-  }) => Promise<Response>;
-}
-interface CreateDocsMcpServerOptions {
-  source: DocsMcpSource;
-  mcp?: boolean | DocsMcpConfig;
-  search?: boolean | DocsSearchConfig;
-  analytics?: boolean | DocsAnalyticsConfig;
-  telemetry?: boolean | DocsTelemetryConfig;
-  telemetryFramework?: DocsTelemetryFramework;
-  observability?: boolean | DocsObservabilityConfig;
-  defaultName?: string;
-  defaultVersion?: string;
-  /** Internal request context used to expose an authenticated principal to custom sources. */
-  requestContext?: DocsMcpRequestContext;
-}
-interface CreateFilesystemDocsMcpSourceOptions {
-  rootDir?: string;
-  entry?: string;
-  contentDir?: string;
-  siteTitle?: string;
-  ordering?: "alphabetical" | "numeric" | OrderingItem[];
-}
-declare const DEFAULT_DOCS_MCP_MAX_BODY_BYTES: number;
-declare const DEFAULT_DOCS_MCP_CORS_MAX_AGE_SECONDS = 600;
-declare const DEFAULT_DOCS_MCP_CORS_ALLOWED_HEADERS: readonly string[];
-declare const DEFAULT_DOCS_MCP_CORS_EXPOSED_HEADERS: readonly string[];
-declare const DOCS_CONFIG_SCHEMA_OPTIONS: readonly DocsMcpConfigSchemaOption[];
-declare function normalizeDocsMcpRoute(route?: string): string;
-declare function resolveDocsMcpConfig(mcp?: boolean | DocsMcpConfig, defaults?: {
-  defaultName?: string;
-  defaultVersion?: string;
-  defaultRoute?: string;
-}): DocsMcpResolvedConfig;
-declare function createFilesystemDocsMcpSource(options?: CreateFilesystemDocsMcpSourceOptions): DocsMcpSource;
-declare function createDocsMcpServer(options: CreateDocsMcpServerOptions): Promise<McpServer>;
-declare function createDocsMcpHttpHandler(options: CreateDocsMcpServerOptions): DocsMcpHttpHandlers;
-declare function runDocsMcpStdio(options: CreateDocsMcpServerOptions): Promise<void>;
-declare function getDocsConfigSchema(filters?: {
-  option?: string;
-  query?: string;
-}): DocsMcpConfigSchema;
-declare function buildDocsMcpContext(options: DocsMcpContextOptions): Promise<DocsMcpContextResult>;
-//#endregion
-export { CreateDocsMcpServerOptions, DEFAULT_DOCS_MCP_CORS_ALLOWED_HEADERS, DEFAULT_DOCS_MCP_CORS_EXPOSED_HEADERS, DEFAULT_DOCS_MCP_CORS_MAX_AGE_SECONDS, DEFAULT_DOCS_MCP_MAX_BODY_BYTES, DOCS_CONFIG_SCHEMA_OPTIONS, DocsMcpAgentContractSummary, DocsMcpCodeExample, DocsMcpConfigSchema, DocsMcpConfigSchemaOption, DocsMcpContextOptions, DocsMcpContextResult, DocsMcpContextSource, DocsMcpDocsList, DocsMcpDocsPageSummary, DocsMcpDocsSection, DocsMcpFolderNode, DocsMcpHttpHandlers, DocsMcpNavigationNode, DocsMcpNavigationTree, DocsMcpPage, DocsMcpPageNode, DocsMcpRequestContext, DocsMcpResolvedConfig, DocsMcpResolvedCorsConfig, DocsMcpResolvedProtectedResourceConfig, DocsMcpResolvedSecurityConfig, DocsMcpSource, DocsMcpTaskSummary, buildDocsMcpContext, createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, getDocsConfigSchema, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio };