@pipeworx/mcp-tldr-pages 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Pipeworx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,59 @@
+# mcp-tldr-pages
+
+tldr-pages community simplified man pages (cached 24h)
+
+Part of [Pipeworx](https://pipeworx.io) — an MCP gateway connecting AI agents to 250+ live data sources.
+
+## Tools
+
+| Tool | Description |
+|------|-------------|
+| `page` | Render tldr page for a command. |
+| `commands` | List commands. |
+| `platforms` | List supported platforms. |
+| `search` | Substring search across page titles. |
+
+## Quick Start
+
+Add to your MCP client (Claude Desktop, Cursor, Windsurf, etc.):
+
+```json
+{
+  "mcpServers": {
+    "tldr-pages": {
+      "url": "https://gateway.pipeworx.io/tldr-pages/mcp"
+    }
+  }
+}
+```
+
+Or connect to the full Pipeworx gateway for access to all 250+ data sources:
+
+```json
+{
+  "mcpServers": {
+    "pipeworx": {
+      "url": "https://gateway.pipeworx.io/mcp"
+    }
+  }
+}
+```
+
+## Using with ask_pipeworx
+
+Instead of calling tools directly, you can ask questions in plain English:
+
+```
+ask_pipeworx({ question: "your question about Tldr Pages data" })
+```
+
+The gateway picks the right tool and fills the arguments automatically.
+
+## More
+
+- [All tools and guides](https://github.com/pipeworx-io/examples)
+- [pipeworx.io](https://pipeworx.io)
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@pipeworx/mcp-tldr-pages",
+  "version": "0.1.0",
+  "description": "tldr-pages community simplified man pages (cached 24h)",
+  "type": "module",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "keywords": ["mcp", "mcp-server", "model-context-protocol", "pipeworx", "tldr-pages"],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/pipeworx-io/mcp-tldr-pages"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.0"
+  }
+}

package/server.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://static.modelcontextprotocol.io/schemas/2025-12-11/server.schema.json",
+  "name": "io.github.pipeworx-io/tldr-pages",
+  "title": "Tldr Pages",
+  "description": "tldr-pages community simplified man pages (cached 24h)",
+  "version": "0.1.0",
+  "websiteUrl": "https://pipeworx.io/packs/tldr-pages",
+  "repository": {
+    "url": "https://github.com/pipeworx-io/mcp-tldr-pages",
+    "source": "github"
+  },
+  "remotes": [
+    {
+      "type": "streamable-http",
+      "url": "https://gateway.pipeworx.io/tldr-pages/mcp"
+    }
+  ]
+}

package/src/index.ts

@@ -0,0 +1,139 @@
+interface McpToolDefinition {
+  name: string;
+  description: string;
+  inputSchema: {
+    type: 'object';
+    properties: Record<string, unknown>;
+    required?: string[];
+  };
+}
+
+interface McpToolExport {
+  tools: McpToolDefinition[];
+  callTool: (name: string, args: Record<string, unknown>) => Promise<unknown>;
+  meter?: { credits: number };
+  cost?: Record<string, unknown>;
+  provider?: string;
+}
+
+/**
+ * tldr-pages MCP — fetched from the canonical github repo.
+ */
+
+
+const REPO = 'https://raw.githubusercontent.com/tldr-pages/tldr/main';
+const INDEX = 'https://tldr.sh/assets/index.json';
+const UA = 'pipeworx-mcp-tldr-pages/1.0 (+https://pipeworx.io)';
+const TTL_MS = 24 * 60 * 60 * 1000;
+let INDEX_CACHE: { at: number; data: { commands: { name: string; platform: string[]; language: string[]; targets?: { os: string; language: string }[] }[] } } | null = null;
+
+const tools: McpToolExport['tools'] = [
+  {
+    name: 'page',
+    description: 'Render tldr page for a command.',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        command: { type: 'string' },
+        platform: { type: 'string', description: 'common (default) | linux | osx | windows | android | sunos | freebsd' },
+        language: { type: 'string', description: 'ISO 639-1, default "en".' },
+      },
+      required: ['command'],
+    },
+  },
+  {
+    name: 'commands',
+    description: 'List commands.',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        platform: { type: 'string' },
+        language: { type: 'string' },
+      },
+    },
+  },
+  {
+    name: 'platforms',
+    description: 'List supported platforms.',
+    inputSchema: { type: 'object', properties: {} },
+  },
+  {
+    name: 'search',
+    description: 'Substring search across page titles.',
+    inputSchema: {
+      type: 'object',
+      properties: {
+        query: { type: 'string' },
+        platform: { type: 'string' },
+        language: { type: 'string' },
+        limit: { type: 'number' },
+      },
+      required: ['query'],
+    },
+  },
+];
+
+async function callTool(name: string, args: Record<string, unknown>): Promise<unknown> {
+  switch (name) {
+    case 'page': {
+      const cmd = reqStr(args, 'command', '"tar"');
+      const platform = String(args.platform ?? 'common');
+      const lang = String(args.language ?? 'en');
+      const dir = lang === 'en' ? 'pages' : `pages.${lang}`;
+      const url = `${REPO}/${dir}/${platform}/${cmd}.md`;
+      const res = await fetch(url, { headers: { 'User-Agent': UA } });
+      if (res.status === 404) {
+        // Fall back to common.
+        if (platform !== 'common') {
+          const fb = await fetch(`${REPO}/${dir}/common/${cmd}.md`, { headers: { 'User-Agent': UA } });
+          if (fb.ok) return { command: cmd, platform: 'common', language: lang, body: await fb.text() };
+        }
+        throw new Error(`tldr: ${cmd} not found on ${platform}/${lang}.`);
+      }
+      if (!res.ok) throw new Error(`tldr: ${res.status}`);
+      return { command: cmd, platform, language: lang, body: await res.text() };
+    }
+    case 'commands': {
+      const idx = await loadIndex();
+      const platform = (args.platform as string | undefined) ?? 'common';
+      const lang = (args.language as string | undefined) ?? 'en';
+      const cmds = idx.commands.filter((c) => c.platform.includes(platform) && c.language.includes(lang)).map((c) => c.name);
+      return { platform, language: lang, count: cmds.length, commands: cmds };
+    }
+    case 'platforms': {
+      const idx = await loadIndex();
+      const set = new Set<string>();
+      for (const c of idx.commands) for (const p of c.platform) set.add(p);
+      return { platforms: [...set].sort() };
+    }
+    case 'search': {
+      const idx = await loadIndex();
+      const q = reqStr(args, 'query', '"compress"').toLowerCase();
+      const platform = args.platform as string | undefined;
+      const lang = (args.language as string | undefined) ?? 'en';
+      const limit = Math.min(500, Math.max(1, (args.limit as number) ?? 50));
+      const matches = idx.commands.filter((c) => c.name.toLowerCase().includes(q) && (!platform || c.platform.includes(platform)) && c.language.includes(lang)).slice(0, limit);
+      return { query: q, count: matches.length, commands: matches };
+    }
+    default:
+      throw new Error(`Unknown tool: ${name}`);
+  }
+}
+
+async function loadIndex() {
+  const now = Date.now();
+  if (INDEX_CACHE && now - INDEX_CACHE.at < TTL_MS) return INDEX_CACHE.data;
+  const res = await fetch(INDEX, { headers: { Accept: 'application/json', 'User-Agent': UA } });
+  if (!res.ok) throw new Error(`tldr index: ${res.status}`);
+  const data = (await res.json()) as typeof INDEX_CACHE['data'];
+  INDEX_CACHE = { at: now, data };
+  return data;
+}
+
+function reqStr(args: Record<string, unknown>, key: string, example: string): string {
+  const v = args[key];
+  if (typeof v !== 'string' || !v.trim()) throw new Error(`Required argument "${key}" is missing. Pass a string like ${example}.`);
+  return v;
+}
+
+export default { tools, callTool, meter: { credits: 1 } } satisfies McpToolExport;

package/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "outDir": "dist",
+    "rootDir": "src",
+    "declaration": true
+  },
+  "include": ["src"]
+}