page

Pack: tldr-pages · Endpoint: https://gateway.pipeworx.io/tldr-pages/mcp

Render tldr page for a command.

Parameters

NameTypeRequiredDescription
commandstringyes
platformstringnocommon (default) | linux | osx | windows | android | sunos | freebsd
languagestringnoISO 639-1, default “en”.

Example call

Arguments

{
  "command": "ls"
}

curl

curl -X POST https://gateway.pipeworx.io/tldr-pages/mcp \
  -H 'Content-Type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"page","arguments":{"command":"ls"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('page', {
  "command": "ls"
});

More examples

{
  "command": "grep",
  "platform": "linux",
  "language": "en"
}

Response shape

Always returns: command, platform, language, body

FieldTypeDescription
commandstringThe command name
platformstringPlatform (common, linux, osx, windows, android, sunos, freebsd)
languagestringISO 639-1 language code
bodystringRendered markdown content of the tldr page
Full JSON Schema
{
  "type": "object",
  "properties": {
    "command": {
      "type": "string",
      "description": "The command name"
    },
    "platform": {
      "type": "string",
      "description": "Platform (common, linux, osx, windows, android, sunos, freebsd)"
    },
    "language": {
      "type": "string",
      "description": "ISO 639-1 language code"
    },
    "body": {
      "type": "string",
      "description": "Rendered markdown content of the tldr page"
    }
  },
  "required": [
    "command",
    "platform",
    "language",
    "body"
  ]
}

Connect

Add this to your MCP client config, or use one-click install buttons:

{
  "mcpServers": {
    "tldr-pages": {
      "url": "https://gateway.pipeworx.io/tldr-pages/mcp"
    }
  }
}

See Getting Started for client-specific install steps.

Regenerated from source · build July 6, 2026