@transcend-io/mcp-server-docs 0.2.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,78 @@
+# @transcend-io/mcp-server-docs
+
+> **Beta** — this package is under active development. APIs may change without notice.
+
+Transcend MCP Server for documentation lookup. Provides tools to list articles from the public docs index and fetch full markdown content on demand.
+
+Requires **Node.js ≥ 22.12** (see `engines` in `package.json`).
+
+**No authentication required.** This standalone server reads public content from `docs.transcend.io` only. It does not use your Transcend API key or OAuth credentials, even if they are present in the environment (for example when launched via [`scripts/mcp-run.sh`](../../../scripts/mcp-run.sh) with `secret.env` loaded).
+
+## Install
+
+Install the CLI globally:
+
+```bash
+npm install -g @transcend-io/mcp-server-docs
+```
+
+Or run from a checkout of this repository (see **Run from the monorepo** below).
+
+## Usage
+
+```bash
+transcend-mcp-docs
+```
+
+The process speaks MCP over **stdio** and is meant to be launched by an MCP client (for example Cursor or Claude Desktop), not used as an interactive shell.
+
+### MCP client configuration
+
+`npx` runs the package’s `transcend-mcp-docs` binary (see `bin` in `package.json`). No `env` block is required.
+
+```json
+{
+  "mcpServers": {
+    "transcend-docs": {
+      "command": "npx",
+      "args": ["-y", "@transcend-io/mcp-server-docs"]
+    }
+  }
+}
+```
+
+When developing in this repository:
+
+```json
+{
+  "mcpServers": {
+    "transcend-docs-local": {
+      "command": "node",
+      "args": ["packages/mcp/mcp-server-docs/dist/cli.mjs"]
+    }
+  }
+}
+```
+
+Build first: `pnpm exec turbo run build --filter="@transcend-io/mcp-server-docs..."`
+
+### Run from the monorepo
+
+```bash
+# from the repository root
+pnpm exec turbo run build --filter="@transcend-io/mcp-server-docs..."
+pnpm -F @transcend-io/mcp-server-docs exec node ./dist/cli.mjs
+```
+
+**Alternative:** `./scripts/mcp-run.sh ./packages/mcp/mcp-server-docs/dist/cli.mjs` (OAuth vars in `secret.env` are ignored by this server).
+
+See [CONTRIBUTING.md](../../../CONTRIBUTING.md#mcp-servers) for workspace layout and `pnpm --filter` workflows.
+
+## Tools
+
+- `transcend_docs_list` — List/search the Transcend docs index (`llms.txt`); optional `section` and `keyword` filters
+- `transcend_docs_fetch` — Fetch full markdown for a docs article URL (host restricted to `docs.transcend.io`)
+
+## Related packages
+
+Also available as part of the unified [`@transcend-io/mcp`](../mcp/README.md), which includes all domains and **does** require authentication. See the [root README](../../../README.md#mcp-servers) for the full list.

package/dist/cli.d.mts

@@ -0,0 +1 @@
+export { };

package/dist/cli.mjs

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+import { t as getDocsTools } from "./tools-CbLvbjwK.mjs";
+import { createMCPServer } from "@transcend-io/mcp-server-base";
+//#endregion
+//#region src/cli.ts
+createMCPServer({
+	name: "transcend-mcp-docs",
+	version: "0.2.2",
+	requireStartupAuth: false,
+	oauthScopes: [],
+	getTools: getDocsTools
+});
+//#endregion
+export {};
+
+//# sourceMappingURL=cli.mjs.map

package/dist/cli.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.mjs","names":["packageJson.version"],"sources":["../package.json","../src/cli.ts"],"sourcesContent":["","#!/usr/bin/env node\nimport { createMCPServer } from '@transcend-io/mcp-server-base';\n\nimport packageJson from '../package.json' with { type: 'json' };\nimport { getDocsTools } from './tools/index.js';\n\ncreateMCPServer({\n  name: 'transcend-mcp-docs',\n  version: packageJson.version,\n  requireStartupAuth: false,\n  oauthScopes: [],\n  getTools: getDocsTools,\n});\n"],"mappings":";;;;;ACMA,gBAAgB;CACd,MAAM;CACGA;CACT,oBAAoB;CACpB,aAAa,EAAE;CACf,UAAU;CACX,CAAC"}

package/dist/index.d.mts

@@ -0,0 +1,48 @@
+import { ToolClients, ToolDefinition, z } from "@transcend-io/mcp-server-base";
+
+//#region src/docsIndex.d.ts
+/** Public docs index URL (llms.txt). */
+declare const LLMS_TXT_URL = "https://docs.transcend.io/llms.txt";
+/** Allowed hostname for fetched documentation articles. */
+declare const DOCS_HOST = "docs.transcend.io";
+/** A single article entry from llms.txt. */
+interface DocEntry {
+  /** Section header from llms.txt (e.g. "General", "Use Case Guides"). */
+  section: string;
+  /** Human-readable article title. */
+  title: string;
+  /** Absolute URL to the article markdown (.md). */
+  url: string;
+}
+/**
+ * Parses llms.txt markdown into structured entries.
+ * Expects `## Section` headers and `- [Title](url)` list items.
+ */
+declare function parseLlmsTxt(raw: string): DocEntry[];
+/** Returns the parsed llms.txt index (cached with TTL). */
+declare function getIndex(): Promise<DocEntry[]>;
+/** Fetches and caches markdown body for a docs.transcend.io article URL. */
+declare function getBody(url: string): Promise<string>;
+/** Validates that a URL targets docs.transcend.io (SSRF guard for fetch). */
+declare function assertDocsHost(url: string): void;
+/** Clears in-memory caches (for tests). */
+declare function resetDocsCachesForTests(): void;
+//#endregion
+//#region src/tools/index.d.ts
+declare function getDocsTools(_clients?: ToolClients): ToolDefinition[];
+//#endregion
+//#region src/tools/docs_fetch.d.ts
+declare const DocsFetchSchema: z.ZodObject<{
+  url: z.ZodString;
+}, z.core.$strip>;
+type DocsFetchInput = z.infer<typeof DocsFetchSchema>;
+//#endregion
+//#region src/tools/docs_list.d.ts
+declare const DocsListSchema: z.ZodObject<{
+  section: z.ZodOptional<z.ZodString>;
+  keyword: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+type DocsListInput = z.infer<typeof DocsListSchema>;
+//#endregion
+export { DOCS_HOST, type DocEntry, type DocsFetchInput, DocsFetchSchema, type DocsListInput, DocsListSchema, LLMS_TXT_URL, assertDocsHost, getBody, getDocsTools, getIndex, parseLlmsTxt, resetDocsCachesForTests };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/docsIndex.ts","../src/tools/index.ts","../src/tools/docs_fetch.ts","../src/tools/docs_list.ts"],"mappings":";;;;cAGa,YAAA;;cAGA,SAAA;;UASI,QAAA;EAZQ;EAcvB,OAAA;EAXW;EAaX,KAAA;;EAEA,GAAA;AAAA;AANF;;;;AAAA,iBAagB,YAAA,CAAa,GAAA,WAAc,QAAA;;iBAuDrB,QAAA,CAAA,GAAY,OAAA,CAAQ,QAAA;;iBASpB,OAAA,CAAQ,GAAA,WAAc,OAAA;AAhE5C;AAAA,iBA0EgB,cAAA,CAAe,GAAA;;iBAaf,uBAAA,CAAA;;;iBC9GA,YAAA,CAAa,QAAA,GAAW,WAAA,GAAc,cAAA;;;cCEzC,eAAA,EAAe,CAAA,CAAA,SAAA;;;KAMhB,cAAA,GAAiB,CAAA,CAAE,KAAA,QAAa,eAAA;;;cCT/B,cAAA,EAAc,CAAA,CAAA,SAAA;;;;KAUf,aAAA,GAAgB,CAAA,CAAE,KAAA,QAAa,cAAA"}

package/dist/index.mjs

@@ -0,0 +1,2 @@
+import { a as LLMS_TXT_URL, c as getIndex, i as DOCS_HOST, l as parseLlmsTxt, n as DocsListSchema, o as assertDocsHost, r as DocsFetchSchema, s as getBody, t as getDocsTools, u as resetDocsCachesForTests } from "./tools-CbLvbjwK.mjs";
+export { DOCS_HOST, DocsFetchSchema, DocsListSchema, LLMS_TXT_URL, assertDocsHost, getBody, getDocsTools, getIndex, parseLlmsTxt, resetDocsCachesForTests };

package/dist/tools-CbLvbjwK.mjs

@@ -0,0 +1,163 @@
+import { LRUCache } from "lru-cache";
+import { createListResult, createToolResult, defineTool, z } from "@transcend-io/mcp-server-base";
+//#region src/docsIndex.ts
+/** Public docs index URL (llms.txt). */
+const LLMS_TXT_URL = "https://docs.transcend.io/llms.txt";
+/** Allowed hostname for fetched documentation articles. */
+const DOCS_HOST = "docs.transcend.io";
+const INDEX_CACHE_KEY = "index";
+const DEFAULT_INDEX_TTL_MS = 1440 * 60 * 1e3;
+const DEFAULT_BODY_TTL_MS = 360 * 60 * 1e3;
+const FETCH_TIMEOUT_MS = 8e3;
+const MAX_BODY_CACHE_ENTRIES = 400;
+/**
+* Parses llms.txt markdown into structured entries.
+* Expects `## Section` headers and `- [Title](url)` list items.
+*/
+function parseLlmsTxt(raw) {
+	const entries = [];
+	let currentSection = "";
+	for (const line of raw.split("\n")) {
+		const sectionMatch = /^## (.+)$/.exec(line);
+		if (sectionMatch?.[1]) {
+			currentSection = sectionMatch[1].trim();
+			continue;
+		}
+		const linkMatch = /^- \[(.+)\]\((.+)\)\s*$/.exec(line);
+		if (linkMatch?.[1] && linkMatch[2] && currentSection) entries.push({
+			section: currentSection,
+			title: linkMatch[1].trim(),
+			url: linkMatch[2].trim()
+		});
+	}
+	return entries;
+}
+async function fetchText(url, signal) {
+	const response = await fetch(url, {
+		headers: { Accept: "text/markdown, text/plain" },
+		signal: signal ?? AbortSignal.timeout(FETCH_TIMEOUT_MS)
+	});
+	if (!response.ok) throw new Error(`Failed to fetch ${url}: HTTP ${response.status}`);
+	return response.text();
+}
+const indexCache = new LRUCache({
+	max: 1,
+	ttl: DEFAULT_INDEX_TTL_MS,
+	allowStale: true,
+	allowStaleOnFetchRejection: true,
+	fetchMethod: async (_key, _stale, { signal }) => {
+		return parseLlmsTxt(await fetchText(LLMS_TXT_URL, signal));
+	}
+});
+const bodyCache = new LRUCache({
+	max: MAX_BODY_CACHE_ENTRIES,
+	ttl: DEFAULT_BODY_TTL_MS,
+	allowStale: true,
+	allowStaleOnFetchRejection: true,
+	fetchMethod: async (url, _stale, { signal }) => fetchText(url, signal)
+});
+/** Returns the parsed llms.txt index (cached with TTL). */
+async function getIndex() {
+	const result = await indexCache.fetch(INDEX_CACHE_KEY);
+	if (!result) throw new Error("Failed to load documentation index");
+	return result;
+}
+/** Fetches and caches markdown body for a docs.transcend.io article URL. */
+async function getBody(url) {
+	assertDocsHost(url);
+	const result = await bodyCache.fetch(url);
+	if (result === void 0) throw new Error(`Failed to fetch documentation: ${url}`);
+	return result;
+}
+/** Validates that a URL targets docs.transcend.io (SSRF guard for fetch). */
+function assertDocsHost(url) {
+	let parsed;
+	try {
+		parsed = new URL(url);
+	} catch {
+		throw new Error(`Invalid documentation URL: ${url}`);
+	}
+	if (parsed.hostname !== "docs.transcend.io") throw new Error(`URL host must be ${DOCS_HOST}, got ${parsed.hostname}`);
+}
+/** Clears in-memory caches (for tests). */
+function resetDocsCachesForTests() {
+	indexCache.clear();
+	bodyCache.clear();
+}
+//#endregion
+//#region src/tools/docs_fetch.ts
+/** Maximum markdown characters returned per article (long pages are truncated). */
+const MAX_BODY_CHARS = 12e4;
+const DocsFetchSchema = z.object({ url: z.string().url().describe("Absolute https URL of a docs.transcend.io article (.md) from transcend_docs_list.") });
+function formatBody(body, url) {
+	return `${body.length > MAX_BODY_CHARS ? `${body.slice(0, MAX_BODY_CHARS)}\n\n...(truncated)` : body}\n\nSource: ${url}`;
+}
+function createDocsFetchTool(_clients) {
+	return defineTool({
+		name: "transcend_docs_fetch",
+		description: "Fetch full markdown content for a Transcend documentation article by URL. Use urls returned by transcend_docs_list.",
+		category: "Documentation",
+		readOnly: true,
+		requireAuth: false,
+		annotations: {
+			readOnlyHint: true,
+			destructiveHint: false,
+			idempotentHint: true
+		},
+		zodSchema: DocsFetchSchema,
+		handler: async ({ url }) => {
+			assertDocsHost(url);
+			return createToolResult(true, {
+				url,
+				markdown: formatBody(await getBody(url), url)
+			});
+		}
+	});
+}
+//#endregion
+//#region src/tools/docs_list.ts
+const DocsListSchema = z.object({
+	section: z.string().optional().describe("Filter articles to this llms.txt section name (exact match)."),
+	keyword: z.string().optional().describe("Case-insensitive substring filter applied to article titles.")
+});
+function filterEntries(entries, section, keyword) {
+	let result = entries;
+	if (section) result = result.filter((entry) => entry.section === section);
+	if (keyword) {
+		const lower = keyword.toLowerCase();
+		result = result.filter((entry) => entry.title.toLowerCase().includes(lower));
+	}
+	return result.map(({ title, section: entrySection, url }) => ({
+		title,
+		section: entrySection,
+		url
+	}));
+}
+function createDocsListTool(_clients) {
+	return defineTool({
+		name: "transcend_docs_list",
+		description: "List Transcend documentation articles from the public docs index. Pick the best matching url, then call transcend_docs_fetch for full markdown content.",
+		category: "Documentation",
+		readOnly: true,
+		requireAuth: false,
+		annotations: {
+			readOnlyHint: true,
+			destructiveHint: false,
+			idempotentHint: true
+		},
+		zodSchema: DocsListSchema,
+		handler: async ({ section, keyword }) => {
+			const filtered = filterEntries(await getIndex(), section, keyword);
+			return createListResult(filtered, { totalCount: filtered.length });
+		}
+	});
+}
+//#endregion
+//#region src/tools/index.ts
+function getDocsTools(_clients) {
+	return [createDocsListTool(), createDocsFetchTool()];
+}
+//#endregion
+export { LLMS_TXT_URL as a, getIndex as c, DOCS_HOST as i, parseLlmsTxt as l, DocsListSchema as n, assertDocsHost as o, DocsFetchSchema as r, getBody as s, getDocsTools as t, resetDocsCachesForTests as u };
+
+//# sourceMappingURL=tools-CbLvbjwK.mjs.map

package/dist/tools-CbLvbjwK.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools-CbLvbjwK.mjs","names":[],"sources":["../src/docsIndex.ts","../src/tools/docs_fetch.ts","../src/tools/docs_list.ts","../src/tools/index.ts"],"sourcesContent":["import { LRUCache } from 'lru-cache';\n\n/** Public docs index URL (llms.txt). */\nexport const LLMS_TXT_URL = 'https://docs.transcend.io/llms.txt';\n\n/** Allowed hostname for fetched documentation articles. */\nexport const DOCS_HOST = 'docs.transcend.io';\n\nconst INDEX_CACHE_KEY = 'index';\nconst DEFAULT_INDEX_TTL_MS = 24 * 60 * 60 * 1000;\nconst DEFAULT_BODY_TTL_MS = 6 * 60 * 60 * 1000;\nconst FETCH_TIMEOUT_MS = 8_000;\nconst MAX_BODY_CACHE_ENTRIES = 400;\n\n/** A single article entry from llms.txt. */\nexport interface DocEntry {\n  /** Section header from llms.txt (e.g. \"General\", \"Use Case Guides\"). */\n  section: string;\n  /** Human-readable article title. */\n  title: string;\n  /** Absolute URL to the article markdown (.md). */\n  url: string;\n}\n\n/**\n * Parses llms.txt markdown into structured entries.\n * Expects `## Section` headers and `- [Title](url)` list items.\n */\nexport function parseLlmsTxt(raw: string): DocEntry[] {\n  const entries: DocEntry[] = [];\n  let currentSection = '';\n\n  for (const line of raw.split('\\n')) {\n    const sectionMatch = /^## (.+)$/.exec(line);\n    if (sectionMatch?.[1]) {\n      currentSection = sectionMatch[1].trim();\n      continue;\n    }\n\n    const linkMatch = /^- \\[(.+)\\]\\((.+)\\)\\s*$/.exec(line);\n    if (linkMatch?.[1] && linkMatch[2] && currentSection) {\n      entries.push({\n        section: currentSection,\n        title: linkMatch[1].trim(),\n        url: linkMatch[2].trim(),\n      });\n    }\n  }\n\n  return entries;\n}\n\nasync function fetchText(url: string, signal?: AbortSignal): Promise<string> {\n  const response = await fetch(url, {\n    headers: { Accept: 'text/markdown, text/plain' },\n    signal: signal ?? AbortSignal.timeout(FETCH_TIMEOUT_MS),\n  });\n  if (!response.ok) {\n    throw new Error(`Failed to fetch ${url}: HTTP ${response.status}`);\n  }\n  return response.text();\n}\n\nconst indexCache = new LRUCache<string, DocEntry[]>({\n  max: 1,\n  ttl: DEFAULT_INDEX_TTL_MS,\n  allowStale: true,\n  allowStaleOnFetchRejection: true,\n  fetchMethod: async (_key, _stale, { signal }) => {\n    const raw = await fetchText(LLMS_TXT_URL, signal);\n    return parseLlmsTxt(raw);\n  },\n});\n\nconst bodyCache = new LRUCache<string, string>({\n  max: MAX_BODY_CACHE_ENTRIES,\n  ttl: DEFAULT_BODY_TTL_MS,\n  allowStale: true,\n  allowStaleOnFetchRejection: true,\n  fetchMethod: async (url, _stale, { signal }) => fetchText(url, signal),\n});\n\n/** Returns the parsed llms.txt index (cached with TTL). */\nexport async function getIndex(): Promise<DocEntry[]> {\n  const result = await indexCache.fetch(INDEX_CACHE_KEY);\n  if (!result) {\n    throw new Error('Failed to load documentation index');\n  }\n  return result;\n}\n\n/** Fetches and caches markdown body for a docs.transcend.io article URL. */\nexport async function getBody(url: string): Promise<string> {\n  assertDocsHost(url);\n  const result = await bodyCache.fetch(url);\n  if (result === undefined) {\n    throw new Error(`Failed to fetch documentation: ${url}`);\n  }\n  return result;\n}\n\n/** Validates that a URL targets docs.transcend.io (SSRF guard for fetch). */\nexport function assertDocsHost(url: string): void {\n  let parsed: URL;\n  try {\n    parsed = new URL(url);\n  } catch {\n    throw new Error(`Invalid documentation URL: ${url}`);\n  }\n  if (parsed.hostname !== DOCS_HOST) {\n    throw new Error(`URL host must be ${DOCS_HOST}, got ${parsed.hostname}`);\n  }\n}\n\n/** Clears in-memory caches (for tests). */\nexport function resetDocsCachesForTests(): void {\n  indexCache.clear();\n  bodyCache.clear();\n}\n","import { createToolResult, defineTool, z, type ToolClients } from '@transcend-io/mcp-server-base';\n\nimport { assertDocsHost, getBody } from '../docsIndex.js';\n\n/** Maximum markdown characters returned per article (long pages are truncated). */\nconst MAX_BODY_CHARS = 120_000;\n\nexport const DocsFetchSchema = z.object({\n  url: z\n    .string()\n    .url()\n    .describe('Absolute https URL of a docs.transcend.io article (.md) from transcend_docs_list.'),\n});\nexport type DocsFetchInput = z.infer<typeof DocsFetchSchema>;\n\nfunction formatBody(body: string, url: string): string {\n  const truncated =\n    body.length > MAX_BODY_CHARS ? `${body.slice(0, MAX_BODY_CHARS)}\\n\\n...(truncated)` : body;\n  return `${truncated}\\n\\nSource: ${url}`;\n}\n\nexport function createDocsFetchTool(_clients?: ToolClients) {\n  return defineTool({\n    name: 'transcend_docs_fetch',\n    description:\n      'Fetch full markdown content for a Transcend documentation article by URL. ' +\n      'Use urls returned by transcend_docs_list.',\n    category: 'Documentation',\n    readOnly: true,\n    requireAuth: false,\n    annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },\n    zodSchema: DocsFetchSchema,\n    handler: async ({ url }) => {\n      assertDocsHost(url);\n      const body = await getBody(url);\n      return createToolResult(true, {\n        url,\n        markdown: formatBody(body, url),\n      });\n    },\n  });\n}\n","import { createListResult, defineTool, z, type ToolClients } from '@transcend-io/mcp-server-base';\n\nimport { getIndex, type DocEntry } from '../docsIndex.js';\n\nexport const DocsListSchema = z.object({\n  section: z\n    .string()\n    .optional()\n    .describe('Filter articles to this llms.txt section name (exact match).'),\n  keyword: z\n    .string()\n    .optional()\n    .describe('Case-insensitive substring filter applied to article titles.'),\n});\nexport type DocsListInput = z.infer<typeof DocsListSchema>;\n\nfunction filterEntries(entries: DocEntry[], section?: string, keyword?: string) {\n  let result = entries;\n  if (section) {\n    result = result.filter((entry) => entry.section === section);\n  }\n  if (keyword) {\n    const lower = keyword.toLowerCase();\n    result = result.filter((entry) => entry.title.toLowerCase().includes(lower));\n  }\n  return result.map(({ title, section: entrySection, url }) => ({\n    title,\n    section: entrySection,\n    url,\n  }));\n}\n\nexport function createDocsListTool(_clients?: ToolClients) {\n  return defineTool({\n    name: 'transcend_docs_list',\n    description:\n      'List Transcend documentation articles from the public docs index. ' +\n      'Pick the best matching url, then call transcend_docs_fetch for full markdown content.',\n    category: 'Documentation',\n    readOnly: true,\n    requireAuth: false,\n    annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true },\n    zodSchema: DocsListSchema,\n    handler: async ({ section, keyword }) => {\n      const entries = await getIndex();\n      const filtered = filterEntries(entries, section, keyword);\n      return createListResult(filtered, { totalCount: filtered.length });\n    },\n  });\n}\n","import type { ToolDefinition, ToolClients } from '@transcend-io/mcp-server-base';\n\nimport { createDocsFetchTool } from './docs_fetch.js';\nimport { createDocsListTool } from './docs_list.js';\n\nexport function getDocsTools(_clients?: ToolClients): ToolDefinition[] {\n  return [createDocsListTool(), createDocsFetchTool()];\n}\n"],"mappings":";;;;AAGA,MAAa,eAAe;;AAG5B,MAAa,YAAY;AAEzB,MAAM,kBAAkB;AACxB,MAAM,uBAAuB,OAAU,KAAK;AAC5C,MAAM,sBAAsB,MAAS,KAAK;AAC1C,MAAM,mBAAmB;AACzB,MAAM,yBAAyB;;;;;AAgB/B,SAAgB,aAAa,KAAyB;CACpD,MAAM,UAAsB,EAAE;CAC9B,IAAI,iBAAiB;AAErB,MAAK,MAAM,QAAQ,IAAI,MAAM,KAAK,EAAE;EAClC,MAAM,eAAe,YAAY,KAAK,KAAK;AAC3C,MAAI,eAAe,IAAI;AACrB,oBAAiB,aAAa,GAAG,MAAM;AACvC;;EAGF,MAAM,YAAY,0BAA0B,KAAK,KAAK;AACtD,MAAI,YAAY,MAAM,UAAU,MAAM,eACpC,SAAQ,KAAK;GACX,SAAS;GACT,OAAO,UAAU,GAAG,MAAM;GAC1B,KAAK,UAAU,GAAG,MAAM;GACzB,CAAC;;AAIN,QAAO;;AAGT,eAAe,UAAU,KAAa,QAAuC;CAC3E,MAAM,WAAW,MAAM,MAAM,KAAK;EAChC,SAAS,EAAE,QAAQ,6BAA6B;EAChD,QAAQ,UAAU,YAAY,QAAQ,iBAAiB;EACxD,CAAC;AACF,KAAI,CAAC,SAAS,GACZ,OAAM,IAAI,MAAM,mBAAmB,IAAI,SAAS,SAAS,SAAS;AAEpE,QAAO,SAAS,MAAM;;AAGxB,MAAM,aAAa,IAAI,SAA6B;CAClD,KAAK;CACL,KAAK;CACL,YAAY;CACZ,4BAA4B;CAC5B,aAAa,OAAO,MAAM,QAAQ,EAAE,aAAa;AAE/C,SAAO,aAAa,MADF,UAAU,cAAc,OAAO,CACzB;;CAE3B,CAAC;AAEF,MAAM,YAAY,IAAI,SAAyB;CAC7C,KAAK;CACL,KAAK;CACL,YAAY;CACZ,4BAA4B;CAC5B,aAAa,OAAO,KAAK,QAAQ,EAAE,aAAa,UAAU,KAAK,OAAO;CACvE,CAAC;;AAGF,eAAsB,WAAgC;CACpD,MAAM,SAAS,MAAM,WAAW,MAAM,gBAAgB;AACtD,KAAI,CAAC,OACH,OAAM,IAAI,MAAM,qCAAqC;AAEvD,QAAO;;;AAIT,eAAsB,QAAQ,KAA8B;AAC1D,gBAAe,IAAI;CACnB,MAAM,SAAS,MAAM,UAAU,MAAM,IAAI;AACzC,KAAI,WAAW,KAAA,EACb,OAAM,IAAI,MAAM,kCAAkC,MAAM;AAE1D,QAAO;;;AAIT,SAAgB,eAAe,KAAmB;CAChD,IAAI;AACJ,KAAI;AACF,WAAS,IAAI,IAAI,IAAI;SACf;AACN,QAAM,IAAI,MAAM,8BAA8B,MAAM;;AAEtD,KAAI,OAAO,aAAA,oBACT,OAAM,IAAI,MAAM,oBAAoB,UAAU,QAAQ,OAAO,WAAW;;;AAK5E,SAAgB,0BAAgC;AAC9C,YAAW,OAAO;AAClB,WAAU,OAAO;;;;;AChHnB,MAAM,iBAAiB;AAEvB,MAAa,kBAAkB,EAAE,OAAO,EACtC,KAAK,EACF,QAAQ,CACR,KAAK,CACL,SAAS,oFAAoF,EACjG,CAAC;AAGF,SAAS,WAAW,MAAc,KAAqB;AAGrD,QAAO,GADL,KAAK,SAAS,iBAAiB,GAAG,KAAK,MAAM,GAAG,eAAe,CAAC,sBAAsB,KACpE,cAAc;;AAGpC,SAAgB,oBAAoB,UAAwB;AAC1D,QAAO,WAAW;EAChB,MAAM;EACN,aACE;EAEF,UAAU;EACV,UAAU;EACV,aAAa;EACb,aAAa;GAAE,cAAc;GAAM,iBAAiB;GAAO,gBAAgB;GAAM;EACjF,WAAW;EACX,SAAS,OAAO,EAAE,UAAU;AAC1B,kBAAe,IAAI;AAEnB,UAAO,iBAAiB,MAAM;IAC5B;IACA,UAAU,WAAW,MAHJ,QAAQ,IAAI,EAGF,IAAI;IAChC,CAAC;;EAEL,CAAC;;;;ACpCJ,MAAa,iBAAiB,EAAE,OAAO;CACrC,SAAS,EACN,QAAQ,CACR,UAAU,CACV,SAAS,+DAA+D;CAC3E,SAAS,EACN,QAAQ,CACR,UAAU,CACV,SAAS,+DAA+D;CAC5E,CAAC;AAGF,SAAS,cAAc,SAAqB,SAAkB,SAAkB;CAC9E,IAAI,SAAS;AACb,KAAI,QACF,UAAS,OAAO,QAAQ,UAAU,MAAM,YAAY,QAAQ;AAE9D,KAAI,SAAS;EACX,MAAM,QAAQ,QAAQ,aAAa;AACnC,WAAS,OAAO,QAAQ,UAAU,MAAM,MAAM,aAAa,CAAC,SAAS,MAAM,CAAC;;AAE9E,QAAO,OAAO,KAAK,EAAE,OAAO,SAAS,cAAc,WAAW;EAC5D;EACA,SAAS;EACT;EACD,EAAE;;AAGL,SAAgB,mBAAmB,UAAwB;AACzD,QAAO,WAAW;EAChB,MAAM;EACN,aACE;EAEF,UAAU;EACV,UAAU;EACV,aAAa;EACb,aAAa;GAAE,cAAc;GAAM,iBAAiB;GAAO,gBAAgB;GAAM;EACjF,WAAW;EACX,SAAS,OAAO,EAAE,SAAS,cAAc;GAEvC,MAAM,WAAW,cAAc,MADT,UAAU,EACQ,SAAS,QAAQ;AACzD,UAAO,iBAAiB,UAAU,EAAE,YAAY,SAAS,QAAQ,CAAC;;EAErE,CAAC;;;;AC3CJ,SAAgB,aAAa,UAA0C;AACrE,QAAO,CAAC,oBAAoB,EAAE,qBAAqB,CAAC"}

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@transcend-io/mcp-server-docs",
+  "version": "0.2.2",
+  "description": "Transcend MCP Server — Documentation lookup tools.",
+  "homepage": "https://github.com/transcend-io/tools/tree/main/packages/mcp/mcp-server-docs",
+  "license": "Apache-2.0",
+  "author": "Transcend Inc.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/transcend-io/tools.git",
+    "directory": "packages/mcp/mcp-server-docs"
+  },
+  "bin": {
+    "transcend-mcp-docs": "./dist/cli.mjs"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": {
+      "@transcend-io/source": "./src/index.ts",
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.29.0",
+    "lru-cache": "^11.5.1",
+    "zod": "^4.3.6",
+    "@transcend-io/mcp-server-base": "0.6.0"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.18.2",
+    "@types/node": "^22.19.15",
+    "publint": "^0.3.18",
+    "tsdown": "^0.21.2",
+    "typescript": "^6.0.0",
+    "vitest": "^4.0.18"
+  },
+  "engines": {
+    "node": ">=22.12.0"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "test": "vitest run",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "check:exports": "attw --pack . --ignore-rules cjs-resolves-to-esm",
+    "check:publint": "publint --level warning --strict --pack pnpm"
+  }
+}