@pipeshub-ai/mcp 2.0.1 → 2.2.0

package/src/funcs/agentsListAgents.ts

@@ -0,0 +1,141 @@
+// Mirrors `usersGetAllUsers.ts`
+// but hits `GET /agents` (operationId `listAgents`). Returns the raw JSON
+// `Response`; the caller parses the `{ success, agents, pagination }` envelope.
+
+import { PipeshubCore } from "../core.js";
+import { encodeFormQuery } from "../lib/encodings.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  ListAgentsRequest,
+  ListAgentsRequest$zodSchema,
+} from "../models/agentops.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+export function agentsListAgents(
+  client$: PipeshubCore,
+  request?: ListAgentsRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    Response,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(client$, request, options));
+}
+
+async function $do(
+  client$: PipeshubCore,
+  request?: ListAgentsRequest | undefined,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      Response,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed$ = safeParse(
+    request,
+    (value$) => ListAgentsRequest$zodSchema.optional().parse(value$),
+    "Input validation failed",
+  );
+  if (!parsed$.ok) {
+    return [parsed$, { status: "invalid" }];
+  }
+  const payload$ = parsed$.value;
+  const body$ = null;
+  const path$ = pathToFunc("/agents")();
+  const query$ = encodeFormQuery({
+    "page": payload$?.page,
+    "limit": payload$?.limit,
+    "search": payload$?.search,
+    "sort_by": payload$?.sortBy,
+    "sort_order": payload$?.sortOrder,
+  });
+
+  const headers$ = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+  const securityInput = await extractSecurity(client$._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client$._options,
+    baseURL: options?.serverURL ?? client$._baseURL ?? "",
+    operationID: "listAgents",
+    oAuth2Scopes: ["agent:read"],
+    resolvedSecurity: requestSecurity,
+    securitySource: client$._options.security,
+    retryConfig: options?.retries
+      || client$._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || [
+      "429",
+      "500",
+      "502",
+      "503",
+      "504",
+    ],
+  };
+
+  const requestRes = client$._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path$,
+    headers: headers$,
+    query: query$,
+    body: body$,
+    userAgent: client$._options.userAgent,
+    timeoutMs: options?.timeoutMs || client$._options.timeoutMs
+      || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req$ = requestRes.value;
+
+  const doResult = await client$._do(req$, {
+    context,
+    errorCodes: [],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req$ }];
+  }
+  return [doResult, {
+    status: "complete",
+    "request": req$,
+    response: doResult.value,
+  }];
+}

package/src/funcs/agentsStreamConversation.ts

@@ -0,0 +1,144 @@
+// POST `/agents/{agentKey}/conversations/stream` (operationId
+// `streamAgentConversation`) to start a conversation with a specific agent.
+// Returns the raw streaming `Response`; the caller parses `text/event-stream`
+// line-by-line.
+
+import { PipeshubCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  AgentStreamCreateConversationRequest,
+  AgentStreamCreateConversationRequest$zodSchema,
+} from "../models/agentops.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+export function agentsStreamConversation(
+  client$: PipeshubCore,
+  request: AgentStreamCreateConversationRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    Response,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(client$, request, options));
+}
+
+async function $do(
+  client$: PipeshubCore,
+  request: AgentStreamCreateConversationRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      Response,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed$ = safeParse(
+    request,
+    (value$) => AgentStreamCreateConversationRequest$zodSchema.parse(value$),
+    "Input validation failed",
+  );
+  if (!parsed$.ok) {
+    return [parsed$, { status: "invalid" }];
+  }
+  const payload$ = parsed$.value;
+  const body$ = encodeJSON("body", payload$.body, { explode: true });
+
+  const pathParams$ = {
+    agentKey: encodeSimple("agentKey", payload$.agentKey, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path$ = pathToFunc(
+    "/agents/{agentKey}/conversations/stream",
+  )(pathParams$);
+
+  const headers$ = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "text/event-stream",
+  }));
+  const securityInput = await extractSecurity(client$._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client$._options,
+    baseURL: options?.serverURL ?? client$._baseURL ?? "",
+    operationID: "streamAgentConversation",
+    oAuth2Scopes: ["agent:execute"],
+    resolvedSecurity: requestSecurity,
+    securitySource: client$._options.security,
+    retryConfig: options?.retries
+      || client$._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || [
+      "429",
+      "500",
+      "502",
+      "503",
+      "504",
+    ],
+  };
+
+  const requestRes = client$._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path$,
+    headers: headers$,
+    body: body$,
+    userAgent: client$._options.userAgent,
+    // SSE streams are long-lived; let the caller's AbortSignal cap it.
+    timeoutMs: options?.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req$ = requestRes.value;
+
+  const doResult = await client$._do(req$, {
+    context,
+    errorCodes: [],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req$ }];
+  }
+  return [doResult, {
+    status: "complete",
+    "request": req$,
+    response: doResult.value,
+  }];
+}

package/src/funcs/agentsStreamMessage.ts

@@ -0,0 +1,147 @@
+// POSTs to `/agents/{agentKey}/conversations/{conversationId}/messages/stream`
+// (operationId `streamAgentConversationMessage`) to append a follow-up turn
+// to an existing agent conversation. Returns the raw streaming `Response`.
+
+import { PipeshubCore } from "../core.js";
+import { encodeJSON, encodeSimple } from "../lib/encodings.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import {
+  AgentAddMessageStreamRequest,
+  AgentAddMessageStreamRequest$zodSchema,
+} from "../models/agentops.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+export function agentsStreamMessage(
+  client$: PipeshubCore,
+  request: AgentAddMessageStreamRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    Response,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(client$, request, options));
+}
+
+async function $do(
+  client$: PipeshubCore,
+  request: AgentAddMessageStreamRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      Response,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed$ = safeParse(
+    request,
+    (value$) => AgentAddMessageStreamRequest$zodSchema.parse(value$),
+    "Input validation failed",
+  );
+  if (!parsed$.ok) {
+    return [parsed$, { status: "invalid" }];
+  }
+  const payload$ = parsed$.value;
+  const body$ = encodeJSON("body", payload$.body, { explode: true });
+
+  const pathParams$ = {
+    agentKey: encodeSimple("agentKey", payload$.agentKey, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+    conversationId: encodeSimple("conversationId", payload$.conversationId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path$ = pathToFunc(
+    "/agents/{agentKey}/conversations/{conversationId}/messages/stream",
+  )(pathParams$);
+
+  const headers$ = new Headers(compactMap({
+    "Content-Type": "application/json",
+    Accept: "text/event-stream",
+  }));
+  const securityInput = await extractSecurity(client$._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client$._options,
+    baseURL: options?.serverURL ?? client$._baseURL ?? "",
+    operationID: "streamAgentConversationMessage",
+    oAuth2Scopes: ["agent:execute"],
+    resolvedSecurity: requestSecurity,
+    securitySource: client$._options.security,
+    retryConfig: options?.retries
+      || client$._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || [
+      "429",
+      "500",
+      "502",
+      "503",
+      "504",
+    ],
+  };
+
+  const requestRes = client$._createRequest(context, {
+    security: requestSecurity,
+    method: "POST",
+    baseURL: options?.serverURL,
+    path: path$,
+    headers: headers$,
+    body: body$,
+    userAgent: client$._options.userAgent,
+    // SSE streams are long-lived; let the caller's AbortSignal cap it.
+    timeoutMs: options?.timeoutMs || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req$ = requestRes.value;
+
+  const doResult = await client$._do(req$, {
+    context,
+    errorCodes: [],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req$ }];
+  }
+  return [doResult, {
+    status: "complete",
+    "request": req$,
+    response: doResult.value,
+  }];
+}

package/src/funcs/connectorGetRecordContent.ts

@@ -0,0 +1,179 @@
+/*
+ * Adapted from Speakeasy-generated connectorGetRecordContent.
+ */
+
+import { PipeshubCore } from "../core.js";
+import { encodeSimple } from "../lib/encodings.js";
+import { compactMap } from "../lib/primitives.js";
+import { safeParse } from "../lib/schemas.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js";
+import { pathToFunc } from "../lib/url.js";
+import { APIError } from "../models/errors/apierror.js";
+import {
+  ConnectionError,
+  InvalidRequestError,
+  RequestAbortedError,
+  RequestTimeoutError,
+  UnexpectedClientError,
+} from "../models/errors/httpclienterrors.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import {
+  GetRecordContentRequest,
+  GetRecordContentRequest$zodSchema,
+} from "../models/getrecordcontentop.js";
+import { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Get a record's full parsed content and metadata
+ *
+ * @remarks
+ * Retrieve the full parsed content and metadata of a single record —
+ * the same content PipesHub's own RAG/chat pipeline uses to answer
+ * questions, returned directly instead of via chat.
+ *
+ * **When to use this vs. the other record endpoints:**
+ * - `GET /knowledgeBase/record/{recordId}` returns metadata only
+ *   (name, type, indexing status, size) — no content.
+ * - `GET /knowledgeBase/stream/record/{recordId}` returns the original,
+ *   unparsed file bytes — use it to download/open the source file.
+ * - **This endpoint** returns the record's full parsed content as a
+ *   single plain-text `content` string (a metadata header, then the
+ *   block/table text in reading order) — use it when you need the
+ *   record's actual textual/tabular content without downloading and
+ *   re-parsing the original file yourself.
+ *
+ * **Typical flow:** obtain a `recordId` from a `pipeshub_search` hit or
+ * a chat citation's `recordId`, then call this endpoint to read the
+ * full content when the search snippet or citation excerpt isn't
+ * enough to answer the question.
+ *
+ * **Permission scoping:**
+ *
+ * The requesting user/token must have access to the record; access is
+ * verified via the knowledge graph before content is returned — a
+ * caller with a valid scope but no access to this specific record gets
+ * a `403`.
+ *
+ * If set, this operation will use either {@link Security.bearerAuth} or {@link Security.oauth2} from the global security.
+ */
+export function connectorGetRecordContent(
+  client$: PipeshubCore,
+  request: GetRecordContentRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    Response,
+    | APIError
+    | SDKValidationError
+    | UnexpectedClientError
+    | InvalidRequestError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | ConnectionError
+  >
+> {
+  return new APIPromise($do(
+    client$,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client$: PipeshubCore,
+  request: GetRecordContentRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      Response,
+      | APIError
+      | SDKValidationError
+      | UnexpectedClientError
+      | InvalidRequestError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | ConnectionError
+    >,
+    APICall,
+  ]
+> {
+  const parsed$ = safeParse(
+    request,
+    (value$) => GetRecordContentRequest$zodSchema.parse(value$),
+    "Input validation failed",
+  );
+  if (!parsed$.ok) {
+    return [parsed$, { status: "invalid" }];
+  }
+  const payload$ = parsed$.value;
+  const body$ = null;
+
+  const pathParams$ = {
+    recordId: encodeSimple("recordId", payload$.recordId, {
+      explode: false,
+      charEncoding: "percent",
+    }),
+  };
+  const path$ = pathToFunc("/connectors/record/{recordId}/content")(
+    pathParams$,
+  );
+
+  const headers$ = new Headers(compactMap({
+    Accept: "application/json",
+  }));
+  const securityInput = await extractSecurity(client$._options.security);
+  const requestSecurity = resolveGlobalSecurity(securityInput);
+
+  const context = {
+    options: client$._options,
+    baseURL: options?.serverURL ?? client$._baseURL ?? "",
+    operationID: "getRecordContent",
+    oAuth2Scopes: ["connector:read"],
+    resolvedSecurity: requestSecurity,
+    securitySource: client$._options.security,
+    retryConfig: options?.retries
+      || client$._options.retryConfig
+      || { strategy: "none" },
+    retryCodes: options?.retryCodes || [
+      "429",
+      "500",
+      "502",
+      "503",
+      "504",
+    ],
+  };
+
+  const requestRes = client$._createRequest(context, {
+    security: requestSecurity,
+    method: "GET",
+    baseURL: options?.serverURL,
+    path: path$,
+    headers: headers$,
+    body: body$,
+    userAgent: client$._options.userAgent,
+    timeoutMs: options?.timeoutMs || client$._options.timeoutMs
+      || -1,
+  }, options);
+  if (!requestRes.ok) {
+    return [requestRes, { status: "invalid" }];
+  }
+  const req$ = requestRes.value;
+
+  const doResult = await client$._do(req$, {
+    context,
+    errorCodes: [],
+    retryConfig: context.retryConfig,
+    retryCodes: context.retryCodes,
+  });
+  if (!doResult.ok) {
+    return [doResult, { status: "request-error", request: req$ }];
+  }
+  return [doResult, {
+    status: "complete",
+    "request": req$,
+    response: doResult.value,
+  }];
+}

package/src/funcs/conversationsStreamConversation.ts

@@ -1,6 +1,4 @@
-// Hand-written supplement (NOT generated). Mirrors
-// `conversationsCreateConversation.ts` but POSTs to `/conversations/stream`
-// and asks for an SSE response. The body shape is identical to the
+// POSTs to `/conversations/stream` and asks for an SSE response. The body shape is identical to the
 // non-streaming sibling, so we reuse `CreateConversationRequest`'s zod
 // schema. Returns the raw streaming `Response`; the caller is expected to
 // parse `text/event-stream` line-by-line.
@@ -89,7 +87,7 @@ async function $do(
     options: client$._options,
     baseURL: options?.serverURL ?? client$._baseURL ?? "",
     operationID: "streamConversation",
-    oAuth2Scopes: ["conversation:write"],
+    oAuth2Scopes: ["conversation:chat"],
     resolvedSecurity: requestSecurity,
     securitySource: client$._options.security,
     retryConfig: options?.retries

package/src/funcs/conversationsStreamMessage.ts

@@ -1,11 +1,3 @@
-// Hand-written supplement (NOT generated). Mirrors
-// `conversationsAddMessage.ts` but POSTs to
-// `/conversations/{conversationId}/messages/stream` and asks for an SSE
-// response. The body shape is identical to the non-streaming sibling, so
-// we reuse `AddMessageRequestRequest`'s zod schema. Returns the raw
-// streaming `Response`; the caller is expected to parse `text/event-stream`
-// line-by-line.
-
 import { PipeshubCore } from "../core.js";
 import { encodeJSON, encodeSimple } from "../lib/encodings.js";
 import { compactMap } from "../lib/primitives.js";

package/src/funcs/userGroupsGetAllUserGroups.ts

@@ -114,7 +114,7 @@ async function $do(
     options: client$._options,
     baseURL: options?.serverURL ?? client$._baseURL ?? "",
     operationID: "getAllUserGroups",
-    oAuth2Scopes: [],
+    oAuth2Scopes: ["usergroup:read"],
     resolvedSecurity: requestSecurity,
     securitySource: client$._options.security,
     retryConfig: options?.retries

package/src/hooks/registration.ts

@@ -1,3 +1,4 @@
+import { RequestIDHook } from "./requestid.js";
 import { Hooks } from "./types.js";
 
 /*
@@ -6,9 +7,9 @@ import { Hooks } from "./types.js";
  * in this file or in separate files in the hooks folder.
  */
 
-// @ts-expect-error remove this line when you add your first hook and hooks is used
 export function initHooks(hooks: Hooks) {
   // Add hooks by calling hooks.register{ClientInit/BeforeCreateRequest/BeforeRequest/AfterSuccess/AfterError}Hook
   // with an instance of a hook that implements that specific Hook interface
   // Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance
+  hooks.registerBeforeRequestHook(new RequestIDHook());
 }