@modeltoolsprotocol/sdk 0.2.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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 the 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 any 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
+
+   Copyright 2025 Nick
+
+   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,111 @@
+# @modeltoolsprotocol/sdk
+
+Add MTP `--describe` support to any Commander.js CLI. One function call, zero boilerplate.
+
+## Install
+
+```bash
+npm install @modeltoolsprotocol/sdk commander
+```
+
+## Quick Start
+
+```typescript
+import { Command } from "commander";
+import { withDescribe } from "@modeltoolsprotocol/sdk";
+
+const program = new Command()
+  .name("filetool")
+  .version("1.0.0")
+  .description("Convert and validate files");
+
+program
+  .command("convert")
+  .argument("<input>", "Input file path")
+  .option("--format <fmt>", "Output format", "json")
+  .option("--pretty", "Pretty-print output")
+  .action((input, opts) => { /* ... */ });
+
+withDescribe(program, {
+  commands: {
+    convert: {
+      stdin: { contentType: "text/plain", description: "Raw input" },
+      stdout: { contentType: "application/json" },
+      examples: [
+        { description: "Convert CSV", command: "filetool convert data.csv --format json" },
+      ],
+    },
+  },
+});
+
+program.parse();
+```
+
+```bash
+$ filetool --describe          # MTP JSON schema
+$ filetool convert data.csv    # normal operation
+```
+
+## API
+
+### `withDescribe(program, options?)`
+
+Adds `--describe` to an existing Commander program. When invoked, outputs MTP-compliant JSON and exits.
+
+- **program** — a Commander `Command` instance (your root program)
+- **options.commands** — per-command annotations keyed by command name (stdin, stdout, examples, argTypes)
+- **options.auth** — authentication config to include in the schema
+- Returns the program for chaining
+
+### `describe(program, options?)`
+
+Pure function. Returns the `ToolSchema` object without side effects. Useful for testing or programmatic access.
+
+## How It Works
+
+The SDK introspects Commander's own data structures — `cmd.options`, `cmd.registeredArguments`, `cmd.commands` — so you never duplicate information. Supplemental metadata (stdin/stdout/examples) that Commander doesn't model is provided via the options map.
+
+### Type Inference
+
+| Commander signal | MTP type |
+|---|---|
+| `option.isBoolean()` | `"boolean"` |
+| `option.argChoices` | `"enum"` + `values` |
+| `option.variadic` / `arg.variadic` | `"array"` |
+| explicit `argTypes` override | whatever you say |
+| everything else | `"string"` |
+
+### Command Naming
+
+- Programs with subcommands: each leaf command gets a space-separated path (e.g., `"auth login"`)
+- Programs with no subcommands: single command named `"_root"`
+- Hidden commands and options are excluded
+
+### Filtered Options
+
+These are automatically excluded from schema output: `--help`, `--version`, `--describe`, and any hidden options.
+
+## Single-Command Tools
+
+Tools with no subcommands work the same way:
+
+```typescript
+import { Command } from "commander";
+import { withDescribe } from "@modeltoolsprotocol/sdk";
+
+const program = new Command()
+  .name("greet")
+  .version("1.0.0")
+  .description("Greet someone")
+  .argument("<name>", "Name to greet")
+  .option("--loud", "Shout the greeting")
+  .action((name, opts) => {
+    const msg = `Hello, ${name}!`;
+    console.log(opts.loud ? msg.toUpperCase() : msg);
+  });
+
+withDescribe(program);
+program.parse();
+```
+
+This produces a schema with a single `_root` command.

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@modeltoolsprotocol/sdk",
+  "version": "0.2.0",
+  "description": "Add MTP --describe support to any Commander.js CLI",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "src/index.ts",
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "scripts": {
+    "test": "bun test"
+  },
+  "peerDependencies": {
+    "commander": ">=12.0.0"
+  },
+  "devDependencies": {
+    "commander": "^14.0.0",
+    "@types/bun": "latest"
+  }
+}

package/src/index.ts

@@ -0,0 +1,34 @@
+import type { Command } from "commander";
+import { generateSchema } from "./introspect.js";
+import type { DescribeOptions, ToolSchema } from "./types.js";
+
+export function describe(program: Command, options?: DescribeOptions): ToolSchema {
+  return generateSchema(program, options);
+}
+
+export function withDescribe(
+  program: Command,
+  options?: DescribeOptions,
+): Command {
+  program.option("--describe", "Output machine-readable MTP JSON schema");
+
+  program.on("option:describe", () => {
+    const schema = describe(program, options);
+    const clean = JSON.parse(JSON.stringify(schema));
+    console.log(JSON.stringify(clean, null, 2));
+    process.exit(0);
+  });
+
+  return program;
+}
+
+export type {
+  ToolSchema,
+  CommandDescriptor,
+  ArgDescriptor,
+  IODescriptor,
+  Example,
+  AuthConfig,
+  DescribeOptions,
+  CommandAnnotation,
+} from "./types.js";

package/src/introspect.ts

@@ -0,0 +1,219 @@
+import type { Command, Option, Argument } from "commander";
+import type {
+  ArgDescriptor,
+  CommandAnnotation,
+  CommandDescriptor,
+  DescribeOptions,
+  ToolSchema,
+} from "./types.js";
+
+// Commander stores these as private fields. We access them for filtering.
+interface CommandInternals {
+  _helpOption?: Option | null;
+  _versionOptionName?: string;
+  _hidden?: boolean;
+  _version?: string;
+}
+
+export function extractArgFromOption(
+  option: Option,
+  typeOverrides?: Record<string, string>,
+): ArgDescriptor {
+  const name = option.long ?? option.short!;
+  const overrideType = typeOverrides?.[option.attributeName()];
+
+  let type: string;
+  let values: string[] | undefined;
+
+  if (overrideType) {
+    type = overrideType;
+  } else if (option.argChoices) {
+    type = "enum";
+    values = [...option.argChoices];
+  } else if (option.variadic) {
+    type = "array";
+  } else if (option.isBoolean()) {
+    type = "boolean";
+  } else {
+    type = "string";
+  }
+
+  const arg: ArgDescriptor = { name, type };
+
+  if (option.description) arg.description = option.description;
+  if (values) arg.values = values;
+
+  // An option is "required" in the MTP sense if it's mandatory (must be specified)
+  arg.required = option.mandatory;
+
+  if (option.defaultValue !== undefined) {
+    let def = option.defaultValue;
+    if (
+      (type === "integer" || type === "number") &&
+      typeof def === "string" &&
+      !isNaN(Number(def))
+    ) {
+      def = Number(def);
+    }
+    arg.default = def;
+  }
+
+  return arg;
+}
+
+export function extractArgFromArgument(
+  argument: Argument,
+  typeOverrides?: Record<string, string>,
+): ArgDescriptor {
+  const name = argument.name();
+  const overrideType = typeOverrides?.[name];
+
+  let type: string;
+  let values: string[] | undefined;
+
+  if (overrideType) {
+    type = overrideType;
+  } else if (argument.argChoices) {
+    type = "enum";
+    values = [...argument.argChoices];
+  } else if (argument.variadic) {
+    type = "array";
+  } else {
+    type = "string";
+  }
+
+  const arg: ArgDescriptor = { name, type };
+
+  if (argument.description) arg.description = argument.description;
+  if (values) arg.values = values;
+
+  arg.required = argument.required;
+
+  if (argument.defaultValue !== undefined) {
+    let def = argument.defaultValue;
+    if (
+      (type === "integer" || type === "number") &&
+      typeof def === "string" &&
+      !isNaN(Number(def))
+    ) {
+      def = Number(def);
+    }
+    arg.default = def;
+  }
+
+  return arg;
+}
+
+export function isFilteredOption(
+  option: Option,
+  cmd: Command,
+  describeOptionName?: string,
+): boolean {
+  if (option.hidden) return true;
+
+  const internals = cmd as unknown as CommandInternals;
+
+  // Filter help option
+  if (internals._helpOption && option === internals._helpOption) return true;
+
+  // Filter version option
+  if (
+    internals._versionOptionName &&
+    option.attributeName() === internals._versionOptionName
+  )
+    return true;
+
+  // Filter the --describe option we added
+  if (describeOptionName && option.attributeName() === describeOptionName)
+    return true;
+
+  return false;
+}
+
+export function walkCommands(
+  cmd: Command,
+  annotations?: Record<string, CommandAnnotation>,
+  parentPath?: string,
+  describeOptionName?: string,
+): CommandDescriptor[] {
+  const internals = cmd as unknown as CommandInternals;
+  const visibleSubcommands = cmd.commands.filter(
+    (sub) => !(sub as unknown as CommandInternals)._hidden,
+  );
+
+  // Leaf command or no subcommands: emit this command
+  if (visibleSubcommands.length === 0) {
+    const name = parentPath || "_root";
+    return [buildCommand(cmd, name, annotations?.[name], describeOptionName)];
+  }
+
+  const results: CommandDescriptor[] = [];
+
+  for (const sub of visibleSubcommands) {
+    const subName = parentPath
+      ? `${parentPath} ${sub.name()}`
+      : sub.name();
+    results.push(
+      ...walkCommands(sub, annotations, subName, describeOptionName),
+    );
+  }
+
+  return results;
+}
+
+function buildCommand(
+  cmd: Command,
+  name: string,
+  annotation?: CommandAnnotation,
+  describeOptionName?: string,
+): CommandDescriptor {
+  const descriptor: CommandDescriptor = {
+    name,
+    description: cmd.description() || "",
+  };
+
+  const args: ArgDescriptor[] = [];
+  const typeOverrides = annotation?.argTypes;
+
+  // Positional arguments first
+  for (const arg of cmd.registeredArguments) {
+    args.push(extractArgFromArgument(arg, typeOverrides));
+  }
+
+  // Then options (filtered)
+  for (const opt of cmd.options) {
+    if (isFilteredOption(opt, cmd, describeOptionName)) continue;
+    args.push(extractArgFromOption(opt, typeOverrides));
+  }
+
+  if (args.length > 0) descriptor.args = args;
+  if (annotation?.stdin) descriptor.stdin = annotation.stdin;
+  if (annotation?.stdout) descriptor.stdout = annotation.stdout;
+  if (annotation?.examples && annotation.examples.length > 0)
+    descriptor.examples = annotation.examples;
+
+  return descriptor;
+}
+
+export function generateSchema(
+  program: Command,
+  options?: DescribeOptions,
+): ToolSchema {
+  const internals = program as unknown as CommandInternals;
+
+  const schema: ToolSchema = {
+    name: program.name(),
+    version: internals._version || "",
+    description: program.description() || "",
+    commands: walkCommands(
+      program,
+      options?.commands,
+      undefined,
+      "describe",
+    ),
+  };
+
+  if (options?.auth) schema.auth = options.auth;
+
+  return schema;
+}

package/src/types.ts

@@ -0,0 +1,55 @@
+export interface Example {
+  description: string;
+  command: string;
+  output?: string;
+}
+
+export interface IODescriptor {
+  contentType?: string;
+  description?: string;
+  schema?: Record<string, unknown>;
+}
+
+export interface ArgDescriptor {
+  name: string;
+  type: string;
+  description?: string;
+  required?: boolean;
+  default?: unknown;
+  values?: string[];
+}
+
+export interface CommandDescriptor {
+  name: string;
+  description: string;
+  args?: ArgDescriptor[];
+  stdin?: IODescriptor;
+  stdout?: IODescriptor;
+  examples?: Example[];
+}
+
+export interface AuthConfig {
+  type: string;
+  description?: string;
+  [key: string]: unknown;
+}
+
+export interface ToolSchema {
+  name: string;
+  version: string;
+  description: string;
+  commands: CommandDescriptor[];
+  auth?: AuthConfig;
+}
+
+export interface CommandAnnotation {
+  stdin?: IODescriptor;
+  stdout?: IODescriptor;
+  examples?: Example[];
+  argTypes?: Record<string, string>;
+}
+
+export interface DescribeOptions {
+  commands?: Record<string, CommandAnnotation>;
+  auth?: AuthConfig;
+}