@browserstack/mcp-server 1.5.0-beta.5 → 1.5.0-beta.7

package/dist/tools/capability-registry/index-loader.d.ts

@@ -46,6 +46,8 @@ export declare class CapabilityRegistry {
     readonly provenance: Record<string, Provenance>;
     /** product -> "METHOD /path" -> capability */
     private readonly byEndpoint;
+    /** product -> capability name -> capability. Empty for products that publish no names. */
+    private readonly byName;
     constructor(index: RegistryIndex, provenance?: Record<string, Provenance>);
     static fromFile(file: string): CapabilityRegistry;
     /**
@@ -63,7 +65,19 @@ export declare class CapabilityRegistry {
     /** Per-product `{build_id, version}`, for logging and cache-busting only. */
     buildInfo(): Record<string, Provenance>;
     /**
-     * Find a capability by the endpoint it exposes — the published handle.
+     * Find a capability by its published name — the preferred handle.
+     *
+     * Names are unique within a product but not across products, so an ambiguous name is
+     * reported rather than resolved by load order. A name that exists in no index is
+     * `unknown_capability`: a distinct outcome from a name that exists elsewhere, because the
+     * caller's next move differs — search again, versus pass `product`.
+     */
+    byNameLookup(name: string, product?: string): {
+        product: string;
+        capability: Capability;
+    };
+    /**
+     * Find a capability by the endpoint it exposes — the handle for unnamed products.
      *
      * The endpoint is what searchCapability returns, so it is the only thing a caller can
      * hold. `unknown_endpoint` is a defined outcome rather than a generic failure: a caller

package/dist/tools/capability-registry/index-loader.js

@@ -107,6 +107,8 @@ export class CapabilityRegistry {
     provenance;
     /** product -> "METHOD /path" -> capability */
     byEndpoint = new Map();
+    /** product -> capability name -> capability. Empty for products that publish no names. */
+    byName = new Map();
     constructor(index, provenance = {}) {
         if (index?.schema_version !== SUPPORTED_SCHEMA_VERSION) {
             throw new IndexError(`unsupported index schema_version ${index?.schema_version}; this build reads ` +
@@ -119,10 +121,25 @@ export class CapabilityRegistry {
         this.provenance = provenance;
         for (const [product, bundle] of Object.entries(index.products)) {
             const lookup = new Map();
+            const names = new Map();
             for (const capability of bundle.capabilities) {
                 lookup.set(endpointKey(capability.method, capability.path), capability);
+                if (!capability.name)
+                    continue;
+                const clash = names.get(capability.name);
+                if (clash) {
+                    // A duplicate name makes one of the two permanently unreachable, and which one
+                    // wins would depend on array order. The export gates this, but a hand-edited or
+                    // stale artifact must not load and then silently drop an endpoint.
+                    throw new IndexError(`${product}: capability name '${capability.name}' is used by both ` +
+                        `${endpointKey(clash.method, clash.path)} and ` +
+                        `${endpointKey(capability.method, capability.path)}; names must be unique ` +
+                        `within a product`);
+                }
+                names.set(capability.name, capability);
             }
             this.byEndpoint.set(product, lookup);
+            this.byName.set(product, names);
         }
     }
     static fromFile(file) {
@@ -183,7 +200,45 @@ export class CapabilityRegistry {
         return this.provenance;
     }
     /**
-     * Find a capability by the endpoint it exposes — the published handle.
+     * Find a capability by its published name — the preferred handle.
+     *
+     * Names are unique within a product but not across products, so an ambiguous name is
+     * reported rather than resolved by load order. A name that exists in no index is
+     * `unknown_capability`: a distinct outcome from a name that exists elsewhere, because the
+     * caller's next move differs — search again, versus pass `product`.
+     */
+    byNameLookup(name, product) {
+        const matches = [];
+        for (const [owner, lookup] of this.byName) {
+            if (product && owner !== product)
+                continue;
+            const capability = lookup.get(name);
+            if (capability)
+                matches.push({ product: owner, capability });
+        }
+        if (matches.length === 0) {
+            // Say whether names are published at all for the product asked about: "no such name"
+            // and "this product does not name its capabilities" need different fixes.
+            const unnamed = [...this.byName]
+                .filter(([owner, lookup]) => (!product || owner === product) && lookup.size === 0)
+                .map(([owner]) => owner);
+            const hint = unnamed.length
+                ? ` ${unnamed.sort().join(", ")} ${unnamed.length > 1 ? "publish" : "publishes"} ` +
+                    `no capability names yet — call those by \`method\` and \`path\` instead.`
+                : " Search again — names come from searchCapability and describeEntity.";
+            throw new InvocationError(`unknown_capability: ${name}.${hint}`);
+        }
+        if (matches.length > 1 && !product) {
+            const owners = matches
+                .map((m) => m.product)
+                .sort()
+                .join(", ");
+            throw new InvocationError(`capability name '${name}' exists in several products (${owners}); pass product`);
+        }
+        return matches[0];
+    }
+    /**
+     * Find a capability by the endpoint it exposes — the handle for unnamed products.
      *
      * The endpoint is what searchCapability returns, so it is the only thing a caller can
      * hold. `unknown_endpoint` is a defined outcome rather than a generic failure: a caller

package/dist/tools/capability-registry/register.js

@@ -193,9 +193,10 @@ export function addCapabilityRegistryTools(server, deps, config) {
         "nothing that fits, do not just rephrase it: call listEntities for the product and " +
         "describeEntity on the closest entity, then search again using the vocabulary they " +
         "return. Narrowing with `product` or `entity` sharpens results further. " +
-        "Each result carries the endpoint's `method` and `path` plus " +
-        "its parameters grouped into path_params / query / body under the spec's own names — " +
-        "pass them straight back to invokeEndpoint, no renaming. `intent` says what it does, " +
+        "Each result carries the capability's `name` — the handle you pass to " +
+        "invokeCapability — plus its `method` and `path` (use those two only when a result " +
+        "has no `name`), and its parameters grouped into path_params / query / body under " +
+        "the spec's own names. Pass them straight back, no renaming. `intent` says what it does, " +
         "`mode` tells you whether it writes, `product` says which product owns it, and " +
         "`responses` describes what a successful call returns, fully expanded. Results are " +
         "ranked and capped, and `truncated` says when more matched. Search before invoking.", {
@@ -257,22 +258,30 @@ export function addCapabilityRegistryTools(server, deps, config) {
             ...rest,
         });
     });
-    tools.invokeEndpoint = server.tool("invokeEndpoint", "Call an endpoint returned by searchCapability. Pass `method` and `path` exactly as " +
-        "given, with arguments grouped into path_params / query / body under the spec's own " +
-        "names. One call makes exactly one request and returns the product's own response " +
-        "untouched; when `completed` is false there is another page, which you fetch by " +
-        "sending the endpoint's own page parameter. If the endpoint's mode is 'write' you " +
-        "MUST ask the user first, then " +
-        "resend with user_permission='granted' and a change_summary; both are recorded. " +
-        "Endpoints whose mode is 'destructive' (deletes) are refused outright — archiving, " +
-        "closing and merging are ordinary writes and DO run, so read the mode and intent " +
-        "before confirming with the user.", {
+    tools.invokeCapability = server.tool("invokeCapability", "Call a capability returned by searchCapability or describeEntity. Pass `name` exactly " +
+        "as given — that is the handle. Only when a result carries no `name` (some products " +
+        "do not publish them yet) pass `method` and `path` instead, exactly as returned. " +
+        "Arguments go in path_params / query / body under the spec's own names. One call " +
+        "makes exactly one request and returns the product's own response untouched; when " +
+        "`completed` is false there is another page, which you fetch by sending the " +
+        "capability's own page parameter. If the mode is 'write' you MUST ask the user " +
+        "first, then resend with user_permission='granted' and a change_summary; both are " +
+        "recorded. Capabilities whose mode is 'destructive' (deletes) are refused outright — " +
+        "archiving, closing and merging are ordinary writes and DO run, so read the mode and " +
+        "intent before confirming with the user.", {
+        name: z
+            .string()
+            .optional()
+            .describe("The capability's published name, exactly as returned (e.g. 'create_test_run_v1'). " +
+            "Preferred over method/path."),
         method: z
             .string()
-            .describe("HTTP method, exactly as searchCapability returned it."),
+            .optional()
+            .describe("HTTP method — only for capabilities returned without a `name`."),
         path: z
             .string()
-            .describe("Path with {placeholders} intact, exactly as returned."),
+            .optional()
+            .describe("Path with {placeholders} intact — only for capabilities returned without a `name`."),
         path_params: z
             .record(z.string(), z.any())
             .optional()
@@ -287,8 +296,8 @@ export function addCapabilityRegistryTools(server, deps, config) {
             .describe("Body fields, under the spec's names."),
         product: productArg()
             .optional()
-            .describe(`Which product owns the endpoint (${productList}). searchCapability returns it ` +
-            "on every result; required only when two products share a path."),
+            .describe(`Which product owns the capability (${productList}). searchCapability returns it ` +
+            "on every result; required only when two products share a name or a path."),
         user_permission: z
             .enum(PERMISSION_VALUES)
             .optional()
@@ -298,7 +307,7 @@ export function addCapabilityRegistryTools(server, deps, config) {
             .optional()
             .describe("What will change. Required for writes."),
     }, {
-        title: "Invoke Endpoint",
+        title: "Invoke Capability",
         // Not read-only: this is the one tool that writes. Never destructive, because
         // destructive endpoints are refused before binding — the refusal is enforced here,
         // not merely hinted at. Not idempotent: it creates, clones and starts runs. Closed
@@ -308,9 +317,20 @@ export function addCapabilityRegistryTools(server, deps, config) {
         idempotentHint: false,
         openWorldHint: false,
     }, async (input) => {
-        track("invokeEndpoint");
+        track("invokeCapability");
         try {
-            const { product, capability } = registry.byEndpointLookup(input.method, input.path, input.product);
+            // Either handle resolves to the same capability. `name` wins when both are sent,
+            // rather than cross-checking them: a caller pasting a stale path alongside a good
+            // name should still reach the right operation, which is the point of naming.
+            if (!input.name && !(input.method && input.path)) {
+                return failed("pass `name` — or, for a capability returned without one, both `method` and " +
+                    "`path`, exactly as searchCapability returned them");
+            }
+            const { product, capability } = input.name
+                ? registry.byNameLookup(input.name, input.product)
+                : registry.byEndpointLookup(input.method, input.path, input.product);
+            /** What to call it in errors — the handle the caller actually used. */
+            const handle = capability.name || `${capability.method} ${capability.path}`;
             const args = {
                 path_params: input.path_params,
                 query: input.query,
@@ -318,8 +338,7 @@ export function addCapabilityRegistryTools(server, deps, config) {
             };
             if (capability.mode === "destructive") {
                 // Refused before binding, so consent is never sought for something that cannot run.
-                return failed(`${input.method} ${input.path} is a destructive operation and is not available ` +
-                    `through this surface`);
+                return failed(`${handle} is a destructive operation and is not available through this surface`);
             }
             if (capability.mode === "write") {
                 const permission = input.user_permission || "not_asked";
@@ -345,8 +364,8 @@ export function addCapabilityRegistryTools(server, deps, config) {
         catch (error) {
             if (error instanceof InvocationError)
                 return failed(error.message);
-            logger.error("invokeEndpoint failed: %s", error instanceof Error ? error.message : String(error));
-            return failed("that endpoint could not be invoked");
+            logger.error("invokeCapability failed: %s", error instanceof Error ? error.message : String(error));
+            return failed("that capability could not be invoked");
         }
     });
     return tools;

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

@@ -36,8 +36,9 @@ export declare function wantsCollection(query: string | undefined): boolean;
  *
  * Pagination is the reliable signal — a paged operation is a listing by construction. The
  * plural terminal path segment is a weaker fallback for unpaged collections. (The Python
- * side used the capability NAME here; the artifact publishes no name, and the path's own
- * terminal noun carries the same signal because operationIds were derived from it.)
+ * side used the capability NAME here. tm now publishes one, but its verbs are not
+ * consistent — the endpoint that lists folders is `get_root_folders_v1` — so the path's
+ * terminal noun remains the better signal.)
  */
 export declare function isCollection(capability: Capability): boolean;
 /**
@@ -45,7 +46,7 @@ export declare function isCollection(capability: Capability): boolean;
  *
  * Attribution is not decoration: the response tables are per product, so dereferencing a
  * hit's schemas needs to know whose tables to read. It is also what lets a caller pass
- * `product` to invokeEndpoint when two products share an endpoint — until now search
+ * `product` to invokeCapability when two products share an endpoint — until now search
  * ranked across products and then threw away the only thing that could disambiguate them.
  */
 export interface SearchHit {

package/dist/tools/capability-registry/search.js

@@ -165,8 +165,9 @@ export function wantsCollection(query) {
  *
  * Pagination is the reliable signal — a paged operation is a listing by construction. The
  * plural terminal path segment is a weaker fallback for unpaged collections. (The Python
- * side used the capability NAME here; the artifact publishes no name, and the path's own
- * terminal noun carries the same signal because operationIds were derived from it.)
+ * side used the capability NAME here. tm now publishes one, but its verbs are not
+ * consistent — the endpoint that lists folders is `get_root_folders_v1` — so the path's
+ * terminal noun remains the better signal.)
  */
 export function isCollection(capability) {
     if (capability.paginated)
@@ -195,7 +196,49 @@ function parameterText(capability) {
     }
     return parts.join(" ");
 }
-/** Path words stand in for the capability name as the identity haystack. */
+/**
+ * Path words are the identity haystack. The published `name` is deliberately NOT scored.
+ *
+ * That is a measured result, not an oversight. tm now names every capability, and adding
+ * the name to the ranking was tried three ways against tests/fixtures/search-eval.json,
+ * which the pre-names index serves 18/18:
+ *
+ *   folded into this field, weight 6          17/18
+ *   its own field, weights 1 / 2 / 3 / 4 / 6  17 / 17 / 17 / 17 / 16
+ *   only the words the path lacks, 1..6       17 / 16 / 15 / 15 / 14
+ *
+ * Every variant loses, for two reasons. The nouns in a name are the route restated — the
+ * name is snake-cased from the operationId, itself derived from the path — so scoring them
+ * again rewards verbose names for repeating themselves: `get_test_cases_for_v1_test_run`
+ * displaced `create_test_result_for_test_case` on "record a pass or fail for a test case in
+ * a run", putting a read above the write that answers it. And what a name adds beyond the
+ * route is mostly its verb, which tm applies inconsistently (`get_root_folders_v1` lists,
+ * `list_folder_test_cases_v1` also lists), so the verb is noise as often as signal.
+ *
+ * The query this was meant to fix, "list all projects", only went 7 -> 4 even where it
+ * helped: `projects` is in 156 of 173 paths as a scope prefix, so rarity correctly values it
+ * near zero and no amount of name weighting recovers it. That one is fixed instead by the
+ * terminal-segment bonus in `score`, which tells "is that thing" from "is scoped by it".
+ *
+ * Revisit when a product ships a consistent verb convention — then the verb becomes signal.
+ */
+/**
+ * The terminal path segment — the thing this endpoint is actually ABOUT.
+ *
+ * A REST path mixes two different things: the resources it is SCOPED BY, and the resource it
+ * ADDRESSES. Only the last segment is the latter. See the bonus in `score` for why that
+ * distinction matters and why it is applied flat rather than weighted.
+ *
+ * Trailing placeholders are skipped, so `/test-cases/{id}` is still about test cases.
+ * Action tails (`close`, `edit`, `delete`) are kept rather than skipped: for "close a test
+ * run" the tail IS the most specific thing the caller said.
+ */
+function resourceText(capability) {
+    const segments = capability.path
+        .split("/")
+        .filter((s) => s && !s.startsWith("{") && s !== "api");
+    return (segments[segments.length - 1] || "").replace(/[-_]/g, " ");
+}
 function identityText(capability) {
     return capability.path
         .split("/")
@@ -225,6 +268,13 @@ function rarity(documents, forms) {
     const total = documents.length || 1;
     return Math.log((total + 1) / (df + 1)) / Math.log(total + 1);
 }
+/**
+ * Sized to sit alongside the mode (+6) and cardinality (+8) constants, not to dwarf them.
+ * The pinned eval is unchanged at every value from 2 to 14 — the bonus only ever fires on
+ * queries it does not cover — so this was chosen on the wider sweep: at 10, "close a test
+ * run" starts pulling `close_exploratory_session` into second place on the tail match alone.
+ */
+const RESOURCE_BONUS = 6;
 function score(capability, wanted, weights, aliases, hint, plural) {
     if (wanted.length === 0)
         return { matched: 1, ranked: 1 };
@@ -273,6 +323,30 @@ function score(capability, wanted, weights, aliases, hint, plural) {
         }
     }
     const matched = ranked;
+    // THE ENDPOINT IS THAT THING, not merely scoped by it.
+    //
+    // A REST path mixes the resources it is SCOPED BY with the one it ADDRESSES. `projects` is
+    // in 156 of tm's 173 paths but is the terminal segment in 3, so whole-corpus rarity —
+    // correctly — values it near nothing, and every project-scoped listing scored the same as
+    // the projects listing itself. The top 8 for "list all projects" spanned 15.9 to 14.8,
+    // where +8 collection and +6 mode already account for 14: the term signal was ~1 point of
+    // noise and the right answer sat 7th.
+    //
+    // Flat, and deliberately NOT rarity-scaled. Rarity would reintroduce the same problem in
+    // reverse — a rare scope noun outranking the real target, which is exactly how a weighted
+    // version of this put `/projects/{id}/folders` above `/folder/{id}/test-cases` for "tc list
+    // for a folder". This asks one yes/no question instead: is the caller's own word the last
+    // thing in the path?
+    //
+    // Equality is against the QUERY's forms, never the haystack's — the same one-directional
+    // rule as containment. `projects` is in forms("projects"), so the projects listing hits;
+    // `folders` is not in forms("folder"), so a folder-scoped query does not drag in the
+    // folders listing.
+    const tail = terms(resourceText(capability));
+    if (tail.length &&
+        wanted.some((forms) => tail.every((word) => forms.includes(word)))) {
+        ranked += RESOURCE_BONUS;
+    }
     if (hint && capability.mode !== hint)
         ranked -= 20;
     else if (hint && capability.mode === hint)

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

@@ -67,6 +67,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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserstack/mcp-server",
-  "version": "1.5.0-beta.5",
+  "version": "1.5.0-beta.7",
   "description": "BrowserStack's Official MCP Server",
   "mcpName": "io.github.browserstack/mcp-server",
   "main": "dist/index.js",