@jalpp/mcp-adapter 0.3.1 → 0.3.3

package/dist/index.d.ts

@@ -146,6 +146,20 @@ interface HttpToolAdapterWithSchema<T extends ZodRawShapeCompat> {
     inputSchema: T;
     /** Optional authentication strategy. */
     auth?: HttpAuth;
+    /**
+     * Optional name of the input parameter whose value will be used as a runtime
+     * bearer token (`Authorization: Bearer <value>`). The parameter is consumed and
+     * never forwarded as a query param or body field.
+     *
+     * When both `tokenParam` and a static `auth` are provided, the runtime token
+     * takes precedence.
+     *
+     * @example
+     * // Schema includes { token: z.string(), userId: z.string() }
+     * tokenParam: "token"
+     * // → Authorization: Bearer <value of args.token>
+     */
+    tokenParam?: string;
     /** Optional extra axios config (e.g. headers, timeout). */
     axiosConfig?: AxiosRequestConfig;
 }
@@ -167,6 +181,11 @@ interface HttpToolAdapterWithoutSchema {
     inputSchema?: undefined;
     /** Optional authentication strategy. */
     auth?: HttpAuth;
+    /**
+     * Not applicable when there is no input schema — included for type symmetry only.
+     * Use the schema variant if you need a runtime token param.
+     */
+    tokenParam?: never;
     /** Optional extra axios config (e.g. headers, timeout). */
     axiosConfig?: AxiosRequestConfig;
 }
@@ -217,6 +236,8 @@ type DeleteToolAdapterConfig<T extends ZodRawShapeCompat> = Omit<HttpToolAdapter
  * - Path variables (`:paramName`) are interpolated from input args.
  * - GET/DELETE: remaining args → query parameters.
  * - POST/PUT/PATCH: remaining args → JSON request body.
+ * - `tokenParam`: if set, the named input field is extracted and used as a runtime
+ *   bearer token, overriding the static `auth` config.
  *
  * @template T - Zod raw shape inferred from `inputSchema`.
  * @param server  - The `McpServer` instance to register the tool on.
@@ -239,10 +260,11 @@ declare function httpToolAdapter(server: McpServer, adapter: HttpToolAdapterWith
  *   name: "get-user",
  *   description: "Fetch a user by ID",
  *   endpoint: "https://api.example.com/users/:userId",
- *   inputSchema: { userId: z.string(), expand: z.string().optional() },
- *   auth: { type: "bearer", token: process.env.API_TOKEN! },
+ *   inputSchema: { userId: z.string(), token: z.string(), expand: z.string().optional() },
+ *   tokenParam: "token",
  * });
  * // GET https://api.example.com/users/abc123?expand=profile
+ * // Authorization: Bearer <token>
  */
 declare function getToolAdapter<T extends ZodRawShapeCompat>(server: McpServer, config: GetToolAdapterConfig<T>): void;
 declare function getToolAdapter(server: McpServer, config: GetToolAdapterConfigNoSchema): void;
@@ -261,10 +283,11 @@ declare function getToolAdapter(server: McpServer, config: GetToolAdapterConfigN
  *   name: "create-post",
  *   description: "Create a new post for a user",
  *   endpoint: "https://api.example.com/users/:userId/posts",
- *   inputSchema: { userId: z.string(), title: z.string(), body: z.string() },
- *   auth: { type: "bearer", token: process.env.API_TOKEN! },
+ *   inputSchema: { userId: z.string(), token: z.string(), title: z.string(), body: z.string() },
+ *   tokenParam: "token",
  * });
  * // POST https://api.example.com/users/abc123/posts  { title, body }
+ * // Authorization: Bearer <token>
  */
 declare function postToolAdapter<T extends ZodRawShapeCompat>(server: McpServer, config: PostToolAdapterConfig<T>): void;
 declare function postToolAdapter(server: McpServer, config: PostToolAdapterConfigNoSchema): void;
@@ -283,10 +306,11 @@ declare function postToolAdapter(server: McpServer, config: PostToolAdapterConfi
  *   name: "update-user",
  *   description: "Replace a user record",
  *   endpoint: "https://api.example.com/users/:userId",
- *   inputSchema: { userId: z.string(), name: z.string(), email: z.string() },
- *   auth: { type: "bearer", token: process.env.API_TOKEN! },
+ *   inputSchema: { userId: z.string(), token: z.string(), name: z.string(), email: z.string() },
+ *   tokenParam: "token",
  * });
  * // PUT https://api.example.com/users/abc123  { name, email }
+ * // Authorization: Bearer <token>
  */
 declare function putToolAdapter<T extends ZodRawShapeCompat>(server: McpServer, config: PutToolAdapterConfig<T>): void;
 /**
@@ -304,10 +328,11 @@ declare function putToolAdapter<T extends ZodRawShapeCompat>(server: McpServer,
  *   name: "update-post-title",
  *   description: "Partially update a post",
  *   endpoint: "https://api.example.com/posts/:postId",
- *   inputSchema: { postId: z.string(), title: z.string() },
- *   auth: { type: "bearer", token: process.env.API_TOKEN! },
+ *   inputSchema: { postId: z.string(), token: z.string(), title: z.string() },
+ *   tokenParam: "token",
  * });
  * // PATCH https://api.example.com/posts/xyz789  { title }
+ * // Authorization: Bearer <token>
  */
 declare function patchToolAdapter<T extends ZodRawShapeCompat>(server: McpServer, config: PatchToolAdapterConfig<T>): void;
 /**
@@ -325,10 +350,11 @@ declare function patchToolAdapter<T extends ZodRawShapeCompat>(server: McpServer
  *   name: "delete-post",
  *   description: "Delete a post by ID",
  *   endpoint: "https://api.example.com/posts/:postId",
- *   inputSchema: { postId: z.string() },
- *   auth: { type: "bearer", token: process.env.API_TOKEN! },
+ *   inputSchema: { postId: z.string(), token: z.string() },
+ *   tokenParam: "token",
  * });
  * // DELETE https://api.example.com/posts/xyz789
+ * // Authorization: Bearer <token>
  */
 declare function deleteToolAdapter<T extends ZodRawShapeCompat>(server: McpServer, config: DeleteToolAdapterConfig<T>): void;