@ttoss/http-server-mcp-openapi 0.8.0 → 0.8.2

package/README.md

@@ -66,10 +66,12 @@ Each OpenAPI operation with an `operationId` and a supported HTTP method
 | path/query/body params    | a single `inputSchema` object                 |
 | `$ref`, `oneOf`, `anyOf`  | dereferenced and merged into a flat schema    |
 | snake_case names          | camelCase tool inputs, mapped back on call    |
-| operation `description`   | tool description (quotes/newlines sanitised)  |
+| operation `description`   | tool description, newlines flattened          |
 | operation `tags`          | tool `tags`, for the deferred `search` filter |
 
-Path params are always required strings. Query and body params carry their
+Path params are always required strings, carrying their own `description`; a
+call missing one is refused before `callApi` runs, whatever
+`validateArguments` says. Query and body params carry their
 declared type and `required` flag. Array params keep their `items` schema. A
 body property declared as a single-entry `allOf` (usually `allOf: [{ $ref }]`
 beside its own `description`) takes `type`, `nullable` and `items` from the

package/dist/index.cjs

@@ -865,7 +865,7 @@ var getJsonSchemaType = schemaType => {
   return "string";
 };
 var sanitizeDescription = description => {
-  return (description || "").replace(/'/g, "\\'").replace(/\n/g, " ").trim();
+  return (description || "").replace(/\n/g, " ").trim();
 };
 var defaultDescribe = ({
   operation
@@ -945,7 +945,7 @@ var buildInputSchema = (pathParams, queryParams, bodyProps) => {
   const properties = {};
   for (const param of modelPathParams) properties[param.argName] = {
     type: "string",
-    description: ""
+    description: sanitizeDescription(param.description)
   };
   for (const param of [...modelQueryParams, ...bodyProps]) properties[param.argName] = normalizeNullable(buildTypedProperty(param));
   return {
@@ -956,6 +956,25 @@ var buildInputSchema = (pathParams, queryParams, bodyProps) => {
     } : {})
   };
 };
+/**
+* Builds the request path. A path without one of its params is another route —
+* `/projects/{id}/members` reaches the API as a `404` naming the resource, not
+* the missing argument — so the call is refused instead.
+*/
+var pathFn = args => {
+  const build = buildPathFn(args.pathTemplate, args.pathParams);
+  const required = values => {
+    const missing = args.pathParams.find(param => {
+      return !param.serverManaged && values[param.argName] === void 0;
+    });
+    if (missing) throw new Error(`Missing required argument "${missing.argName}".`);
+    return build(values);
+  };
+  return withPinned({
+    build: required,
+    pinned: args.pinned
+  });
+};
 var SUPPORTED_METHODS = ["GET", "POST", "PUT", "PATCH", "DELETE"];
 /** The tool description, from `options.describe` or the default. */
 var describeOperation = args => {
@@ -1048,8 +1067,9 @@ var processOperation = args => {
     pathTemplate: args.pathTemplate,
     operationId: args.operation.operationId,
     tags: operationTags(args.operation),
-    path: withPinned({
-      build: buildPathFn(args.pathTemplate, pathParams),
+    path: pathFn({
+      pathTemplate: args.pathTemplate,
+      pathParams,
       pinned
     }),
     query: withPinned({

package/dist/index.d.cts

@@ -51,7 +51,10 @@ interface ToolDefinition {
   operationId: string;
   /** The operation's `tags`, e.g. to filter the deferred `search` by module. */
   tags: string[];
-  /** Builds the request path, substituting path params from the args. */
+  /**
+   * Builds the request path, substituting path params from the args. Throws
+   * when an argument a path param needs is missing.
+   */
   path: (args: Record<string, unknown>) => string;
   /** Builds the query string (including leading `?`), or `undefined` if none. */
   query?: (args: Record<string, unknown>) => string;
@@ -608,6 +611,7 @@ declare const getJsonSchemaType: (schemaType: string | undefined) => JsonSchemaP
 declare const buildInputSchema: (pathParams: Array<{
   name: string;
   argName: string;
+  description?: string;
   serverManaged?: boolean;
 }>, queryParams: Array<{
   name: string;

package/dist/index.d.mts

@@ -51,7 +51,10 @@ interface ToolDefinition {
   operationId: string;
   /** The operation's `tags`, e.g. to filter the deferred `search` by module. */
   tags: string[];
-  /** Builds the request path, substituting path params from the args. */
+  /**
+   * Builds the request path, substituting path params from the args. Throws
+   * when an argument a path param needs is missing.
+   */
   path: (args: Record<string, unknown>) => string;
   /** Builds the query string (including leading `?`), or `undefined` if none. */
   query?: (args: Record<string, unknown>) => string;
@@ -608,6 +611,7 @@ declare const getJsonSchemaType: (schemaType: string | undefined) => JsonSchemaP
 declare const buildInputSchema: (pathParams: Array<{
   name: string;
   argName: string;
+  description?: string;
   serverManaged?: boolean;
 }>, queryParams: Array<{
   name: string;

package/dist/index.mjs

@@ -862,7 +862,7 @@ var getJsonSchemaType = schemaType => {
   return "string";
 };
 var sanitizeDescription = description => {
-  return (description || "").replace(/'/g, "\\'").replace(/\n/g, " ").trim();
+  return (description || "").replace(/\n/g, " ").trim();
 };
 var defaultDescribe = ({
   operation
@@ -942,7 +942,7 @@ var buildInputSchema = (pathParams, queryParams, bodyProps) => {
   const properties = {};
   for (const param of modelPathParams) properties[param.argName] = {
     type: "string",
-    description: ""
+    description: sanitizeDescription(param.description)
   };
   for (const param of [...modelQueryParams, ...bodyProps]) properties[param.argName] = normalizeNullable(buildTypedProperty(param));
   return {
@@ -953,6 +953,25 @@ var buildInputSchema = (pathParams, queryParams, bodyProps) => {
     } : {})
   };
 };
+/**
+* Builds the request path. A path without one of its params is another route —
+* `/projects/{id}/members` reaches the API as a `404` naming the resource, not
+* the missing argument — so the call is refused instead.
+*/
+var pathFn = args => {
+  const build = buildPathFn(args.pathTemplate, args.pathParams);
+  const required = values => {
+    const missing = args.pathParams.find(param => {
+      return !param.serverManaged && values[param.argName] === void 0;
+    });
+    if (missing) throw new Error(`Missing required argument "${missing.argName}".`);
+    return build(values);
+  };
+  return withPinned({
+    build: required,
+    pinned: args.pinned
+  });
+};
 var SUPPORTED_METHODS = ["GET", "POST", "PUT", "PATCH", "DELETE"];
 /** The tool description, from `options.describe` or the default. */
 var describeOperation = args => {
@@ -1045,8 +1064,9 @@ var processOperation = args => {
     pathTemplate: args.pathTemplate,
     operationId: args.operation.operationId,
     tags: operationTags(args.operation),
-    path: withPinned({
-      build: buildPathFn(args.pathTemplate, pathParams),
+    path: pathFn({
+      pathTemplate: args.pathTemplate,
+      pathParams,
       pinned
     }),
     query: withPinned({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/http-server-mcp-openapi",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "description": "Generate Model Context Protocol (MCP) tools from an OpenAPI specification for @ttoss/http-server-mcp",
   "keywords": [
     "ai",
@@ -36,8 +36,8 @@
     "dist"
   ],
   "dependencies": {
-    "@ttoss/http-server-mcp": "^0.34.0",
-    "@ttoss/http-server": "^0.11.1"
+    "@ttoss/http-server": "^0.11.1",
+    "@ttoss/http-server-mcp": "^0.34.2"
   },
   "devDependencies": {
     "@modelcontextprotocol/server": "^2.0.0",