@browserstack/mcp-server 1.5.0-beta.2 → 1.5.0-beta.20

package/dist/tools/capability-registry/types.d.ts

@@ -27,7 +27,47 @@ export declare const SUPPORTED_SCHEMA_VERSION = 1;
 export declare const ENVELOPE_KEYS: readonly ["schema_version", "version", "build_id", "harness_commit", "products"];
 export type Mode = "read" | "write" | "destructive";
 /** One parameter, under the name the OpenAPI spec itself gives it. */
-export interface WireParam {
+/**
+ * The constraints a parameter may declare beyond its type.
+ *
+ * ALL OPTIONAL, and absent means unchecked. The released artifact carries none of these
+ * yet — tm's spec holds 59 `format`, 50 `default`, 23 `minimum`, 12 `maximum`, 10
+ * `minItems`, 7 `maxItems`, 4 `minLength`, 3 `pattern` and 2 `maxLength` that the export
+ * currently drops — so this ships inert and starts working the moment the export carries
+ * them. An older index must keep binding exactly as it does today.
+ */
+export interface WireConstraints {
+    /** Numbers. `multipleOf` is checked on the coerced number, not the raw string. */
+    minimum?: number;
+    maximum?: number;
+    multipleOf?: number;
+    /** Strings. `pattern` is an unanchored regex, compiled with `u` for `\p{…}` classes. */
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+    format?: string;
+    /** Arrays. */
+    minItems?: number;
+    maxItems?: number;
+    uniqueItems?: boolean;
+    /**
+     * The value the product uses when the field is omitted.
+     *
+     * PUBLISHED, NOT INJECTED. Telling a caller the default is what stops the redundant send;
+     * filling it in here would put a value on the wire that the caller never chose, and pin
+     * a server-side default that is free to change. Omission and "explicitly the default" are
+     * different requests, and only the product knows whether that difference matters.
+     */
+    default?: unknown;
+}
+/** One field inside an array item or a nested object — same constraints, one level down. */
+export interface WireField extends WireConstraints {
+    name: string;
+    type: string;
+    required?: true;
+    values?: unknown[];
+}
+export interface WireParam extends WireConstraints {
     name: string;
     type: string;
     required?: true;
@@ -35,11 +75,7 @@ export interface WireParam {
     example?: unknown;
     description?: string;
     /** Field names/types one level inside an array item or nested object. */
-    fields?: {
-        name: string;
-        type: string;
-        required?: true;
-    }[];
+    fields?: WireField[];
     /**
      * Where a body field sits in the JSON, when that differs from its name. Published
      * because the nesting is not guessable and getting it wrong fails silently — tm's folder
@@ -67,6 +103,17 @@ export interface ResponseDoc extends ComponentRef {
 }
 /** A capability, keyed by the endpoint it exposes. There is deliberately no name. */
 export interface Capability {
+    /**
+     * The caller-facing handle — the snake-cased `operationId`, unique within its product.
+     *
+     * This is what `invokeCapability` takes, and what `entities[*].capabilities[]` lists. It
+     * is stable where a route is not: `/edit` becoming `/edit-v2` must not break a caller
+     * holding a handle.
+     *
+     * OPTIONAL because not every product publishes it yet — loadtesting's index carries none.
+     * For those, the endpoint remains the handle, so nothing may assume this is present.
+     */
+    name?: string;
     method: string;
     path: string;
     mode: Mode;
@@ -101,6 +148,20 @@ export interface Capability {
 }
 export interface EntityDoc {
     title?: string;
+    /**
+     * One line saying what this entity IS. Rides on `listProducts`, next to the aliases.
+     *
+     * Aliases route; they do not define. `version -> history, revision, version-history`
+     * tells a caller which words land here and nothing about whether that is the versioning
+     * of a test case or of a project. Without this line the only way to find out is
+     * `describeEntity`, once per entity — 19 calls at ~1.4KB for tm, against ~1.6KB to
+     * answer it for all of them at once.
+     *
+     * Capped at 140 characters by the build, and dropped rather than truncated when longer.
+     * Often absent: a product that has not authored these emits none (loadtesting has 0 of
+     * 9 today), and absence means "unwritten", never an error.
+     */
+    description?: string;
     aliases?: string[];
     id_convention?: string;
     parents?: string[];
@@ -108,6 +169,19 @@ export interface EntityDoc {
         entity?: string;
         via?: string;
     }[];
+    /**
+     * What a caller gets wrong about this ENTITY, as opposed to one operation.
+     *
+     * The entity-wide half of guidance: "a run's `id` is the display string, take `uuid`"
+     * holds for every capability returning a run, so it is stated once here rather than
+     * copied onto each capability's `guidance` — which would repeat across ~20 records and,
+     * since guidance is a search haystack, dilute ranking with boilerplate.
+     *
+     * Filtered at build time and often absent: of tm's 155 authored facts, 73 are publishable
+     * as written and the rest name routes, HTTP verbs or wire-shaped parameters. Absent means
+     * "none passed", never an error.
+     */
+    key_facts?: string[];
     [key: string]: unknown;
 }
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserstack/mcp-server",
-  "version": "1.5.0-beta.2",
+  "version": "1.5.0-beta.20",
   "description": "BrowserStack's Official MCP Server",
   "mcpName": "io.github.browserstack/mcp-server",
   "main": "dist/index.js",
@@ -15,7 +15,12 @@
     "dev": "tsx watch --clear-screen=false src/index.ts",
     "test": "vitest run",
     "lint": "eslint . --ext .ts",
-    "format": "prettier --write \"src/**/*.ts\""
+    "format": "prettier --write \"src/**/*.ts\"",
+    "check:contract": "python3 scripts/check-contract.py capability/tm.capability-index.json --baseline scripts/contract-baseline/tm.json --quiet && python3 scripts/check-contract.py capability/loadtesting.capability-index.json --baseline scripts/contract-baseline/loadtesting.json --quiet",
+    "eval:index": "tsx scripts/eval-index.mts",
+    "seed:live": "tsx scripts/seed-live.mts",
+    "plan:tests": "tsx scripts/plan-capability-tests.mts",
+    "replay:live": "tsx scripts/replay-live.mts"
   },
   "bin": {
     "browserstack-mcp-server": "dist/index.js"