tty-table 6.0.1 → 6.1.0

package/README.md

@@ -33,6 +33,61 @@ $ node examples/data/fake-stream.js | tty-table --format json --header examples/
 $ tty-table -h
 ```
 
+### MCP server
+
+Expose tty-table to MCP clients (Claude, IDE agents, Cursor, etc.) over stdio.
+
+#### Client configuration
+
+```json
+{
+  "mcpServers": {
+    "tty-table": {
+      "command": "npx",
+      "args": ["-y", "--package=tty-table", "tty-table-mcp"]
+    }
+  }
+}
+```
+
+#### Tools
+
+| Tool | Description |
+|------|-------------|
+| `render_table` | Render data as an ASCII/Unicode terminal table. Accepts `header`, `rows`, and any tty-table `options`; returns the rendered table as text. |
+
+**Arguments for `render_table`:**
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `header` | `(string \| {value, align?, width?})[]` | no | Column definitions |
+| `rows` | `(unknown[] \| Record<string, unknown>)[]` | yes | Row data (arrays of cells, or objects keyed by column name) |
+| `options` | `object` | no | Any tty-table option (e.g. `width`, `borderStyle`, `align`, `compact`) |
+
+Example tool call:
+
+```json
+{
+  "header": [{ "value": "name" }, { "value": "score", "align": "right" }],
+  "rows": [["Ada", 100], ["Grace", 98]],
+  "options": { "width": 40 }
+}
+```
+
+Rendered result:
+
+```text
+  ┌───────┬───────┐
+  │ name  │ score │
+  ├───────┼───────┤
+  │  Ada  │   100 │
+  ├───────┼───────┤
+  │ Grace │    98 │
+  └───────┴───────┘
+```
+
+> Additional tools may be added in future releases under the same MCP server.
+
 ### Browser & Browser Console 
 
 - View in Chrome or Chromium at [http://localhost:8070/examples/browser-example.html](http://localhost:8070/examples/browser-example.html) using a dockerized apache instance:

package/dist/mcp.d.mts

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { z } from 'zod';
+
+declare const headerEntry: z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+    value: z.ZodString;
+    align: z.ZodOptional<z.ZodEnum<{
+        left: "left";
+        center: "center";
+        right: "right";
+    }>>;
+    width: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+}, z.core.$strip>]>;
+/** Shared input schema for the render_table tool (used by server + tests). */
+declare const renderTableInputSchema: {
+    header: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        value: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<{
+            left: "left";
+            center: "center";
+            right: "right";
+        }>>;
+        width: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+    }, z.core.$strip>]>>>;
+    rows: z.ZodArray<z.ZodUnion<readonly [z.ZodArray<z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+};
+type RenderTableArgs = {
+    header?: Array<z.infer<typeof headerEntry>> | undefined;
+    rows: Array<unknown[] | Record<string, unknown>>;
+    options?: Record<string, unknown> | undefined;
+};
+/**
+ * Core handler for the render_table MCP tool.
+ * Extracted so unit tests can exercise success and error paths without
+ * starting a stdio transport.
+ */
+declare function handleRenderTable({ header, rows, options }: RenderTableArgs): {
+    content: {
+        type: "text";
+        text: string;
+    }[];
+    isError?: never;
+} | {
+    isError: true;
+    content: {
+        type: "text";
+        text: string;
+    }[];
+};
+/** Build a configured McpServer instance (does not connect a transport). */
+declare function createMcpServer(): McpServer;
+
+export { type RenderTableArgs, createMcpServer, handleRenderTable, renderTableInputSchema };

package/dist/mcp.d.ts

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { z } from 'zod';
+
+declare const headerEntry: z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+    value: z.ZodString;
+    align: z.ZodOptional<z.ZodEnum<{
+        left: "left";
+        center: "center";
+        right: "right";
+    }>>;
+    width: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+}, z.core.$strip>]>;
+/** Shared input schema for the render_table tool (used by server + tests). */
+declare const renderTableInputSchema: {
+    header: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
+        value: z.ZodString;
+        align: z.ZodOptional<z.ZodEnum<{
+            left: "left";
+            center: "center";
+            right: "right";
+        }>>;
+        width: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+    }, z.core.$strip>]>>>;
+    rows: z.ZodArray<z.ZodUnion<readonly [z.ZodArray<z.ZodUnknown>, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
+    options: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+};
+type RenderTableArgs = {
+    header?: Array<z.infer<typeof headerEntry>> | undefined;
+    rows: Array<unknown[] | Record<string, unknown>>;
+    options?: Record<string, unknown> | undefined;
+};
+/**
+ * Core handler for the render_table MCP tool.
+ * Extracted so unit tests can exercise success and error paths without
+ * starting a stdio transport.
+ */
+declare function handleRenderTable({ header, rows, options }: RenderTableArgs): {
+    content: {
+        type: "text";
+        text: string;
+    }[];
+    isError?: never;
+} | {
+    isError: true;
+    content: {
+        type: "text";
+        text: string;
+    }[];
+};
+/** Build a configured McpServer instance (does not connect a transport). */
+declare function createMcpServer(): McpServer;
+
+export { type RenderTableArgs, createMcpServer, handleRenderTable, renderTableInputSchema };