@nimbus-dev/connectors 0.2.1 → 0.2.2

package/connectors/github-actions/src/tools.ts

@@ -0,0 +1,209 @@
+import { z } from "zod";
+import type { ConsentServer } from "../../../shared/consent-kit.ts";
+import { createWriteToolRegistrar } from "../../../shared/consent-kit.ts";
+import {
+  GH_ACCEPT,
+  GH_API,
+  GH_API_VERSION,
+  ghFetch,
+  ghQueryPath,
+  ghRepoPath,
+  setGhPaging,
+} from "../../../shared/github-rest.ts";
+import {
+  createRegisterSimpleTool,
+  createZodToolRegistrar,
+  mcpJsonResult as jsonResult,
+  requireProcessEnv,
+} from "../../../shared/mcp-tool-kit.ts";
+import { makeRestToolRegistrar } from "../../../shared/rest-tool-kit.ts";
+
+/** Tool names exposed by this connector — for contract/introspection tests. */
+export const GITHUB_ACTIONS_TOOL_NAMES = [
+  "gha_workflow_list",
+  "gha_run_list",
+  "gha_run_get",
+  "gha_run_jobs",
+  "gha_run_log",
+  "gha_run_trigger",
+  "gha_run_cancel",
+] as const;
+
+export function registerGithubActionsTools(
+  server: ConsentServer & { tool: (...args: never) => unknown },
+): void {
+  const reg = createZodToolRegistrar(createRegisterSimpleTool(server));
+
+  /**
+   * Every MUTATING github-actions tool goes through here. Outside the gateway this adds the
+   * consent gate, the write-scope allow-list, the mutation budget and the audit record; inside
+   * the gateway it is a pass-through, because executor.ts (I2) is the gate there.
+   */
+  const registerWriteTool = createWriteToolRegistrar(server, {
+    connector: "github-actions",
+    scopeEnv: "NIMBUS_MCP_GITHUB_ACTIONS_WRITE_SCOPE",
+    scopeKinds: ["repo"],
+  });
+
+  /** Standard GitHub Actions tool: token → ghFetch(buildPath) → mcpJsonResultIfOk("GitHub Actions"). */
+  const registerGhaTool = makeRestToolRegistrar({
+    registrar: reg,
+    tokenEnv: "GITHUB_PAT",
+    serviceLabel: "GitHub Actions",
+    fetch: ghFetch,
+  });
+
+  const repoSlugArgs = z.object({
+    owner: z.string().min(1),
+    repo: z.string().min(1),
+  });
+
+  const runListSchema = repoSlugArgs.extend({
+    perPage: z.number().int().min(1).max(100).optional(),
+    page: z.number().int().min(1).optional(),
+    branch: z.string().optional(),
+    event: z.string().optional(),
+    status: z.string().optional(),
+  });
+
+  registerGhaTool(
+    "gha_workflow_list",
+    "List GitHub Actions workflows for a repository.",
+    repoSlugArgs.extend({
+      perPage: z.number().int().min(1).max(100).optional(),
+      page: z.number().int().min(1).optional(),
+    }),
+    (parsed) =>
+      ghQueryPath(`${ghRepoPath(parsed.owner, parsed.repo)}/actions/workflows`, (q) => {
+        setGhPaging(q, parsed);
+      }),
+  );
+
+  registerGhaTool("gha_run_list", "List workflow runs for a repository.", runListSchema, (parsed) =>
+    ghQueryPath(`${ghRepoPath(parsed.owner, parsed.repo)}/actions/runs`, (q) => {
+      setGhPaging(q, parsed);
+      if (parsed.branch !== undefined) {
+        q.set("branch", parsed.branch);
+      }
+      if (parsed.event !== undefined) {
+        q.set("event", parsed.event);
+      }
+      if (parsed.status !== undefined) {
+        q.set("status", parsed.status);
+      }
+    }),
+  );
+
+  const runIdSchema = repoSlugArgs.extend({
+    runId: z.number().int().min(1),
+  });
+
+  registerGhaTool(
+    "gha_run_get",
+    "Get a single workflow run by id.",
+    runIdSchema,
+    (parsed) => `${ghRepoPath(parsed.owner, parsed.repo)}/actions/runs/${String(parsed.runId)}`,
+  );
+
+  registerGhaTool(
+    "gha_run_jobs",
+    "List jobs for a workflow run.",
+    runIdSchema,
+    (parsed) =>
+      `${ghRepoPath(parsed.owner, parsed.repo)}/actions/runs/${String(parsed.runId)}/jobs`,
+  );
+
+  reg(
+    "gha_run_log",
+    "Download console log text for a job (truncated).",
+    repoSlugArgs.extend({
+      jobId: z.number().int().min(1),
+      maxChars: z.number().int().min(1000).max(500_000).optional(),
+    }),
+    async (parsed) => {
+      const token = requireProcessEnv("GITHUB_PAT");
+      const url = `${GH_API}${ghRepoPath(parsed.owner, parsed.repo)}/actions/jobs/${String(parsed.jobId)}/logs`;
+      const res = await fetch(url, {
+        headers: {
+          Accept: GH_ACCEPT,
+          Authorization: `Bearer ${token}`,
+          "X-GitHub-Api-Version": GH_API_VERSION,
+        },
+        redirect: "follow",
+      });
+      const text = await res.text();
+      if (!res.ok) {
+        throw new Error(`GitHub Actions logs ${String(res.status)}: ${text.slice(0, 400)}`);
+      }
+      const max = parsed.maxChars ?? 64_000;
+      const tail = text.length > max ? text.slice(-max) : text;
+      return jsonResult({
+        jobId: parsed.jobId,
+        truncated: text.length > max,
+        totalChars: text.length,
+        text: tail,
+      });
+    },
+  );
+
+  registerWriteTool(
+    "gha_run_trigger",
+    {
+      mutates: "github_actions.run.trigger",
+      recoverable: true,
+      scopeTargetOf: (p) => ({ kind: "repo", value: `${p.owner}/${p.repo}` }),
+    },
+    "Dispatch a workflow (workflow_dispatch).",
+    repoSlugArgs.extend({
+      workflowId: z
+        .string()
+        .min(1)
+        .describe("Numeric workflow id or workflow file name (e.g. ci.yml)"),
+      ref: z.string().min(1).optional(),
+      inputs: z.record(z.string(), z.string()).optional(),
+    }),
+    async (parsed) => {
+      const token = requireProcessEnv("GITHUB_PAT");
+      const encWf = encodeURIComponent(parsed.workflowId);
+      const path = `${ghRepoPath(parsed.owner, parsed.repo)}/actions/workflows/${encWf}/dispatches`;
+      const ref = parsed.ref ?? "main";
+      const res = await ghFetch(token, path, {
+        method: "POST",
+        headers: { "Content-Type": "application/json" },
+        body: JSON.stringify({
+          ref,
+          inputs: parsed.inputs ?? {},
+        }),
+      });
+      if (!res.ok) {
+        throw new Error(`GitHub Actions dispatch ${String(res.status)}: ${res.text.slice(0, 400)}`);
+      }
+      return jsonResult({
+        ok: true,
+        owner: parsed.owner,
+        repo: parsed.repo,
+        workflowId: parsed.workflowId,
+      });
+    },
+  );
+
+  registerWriteTool(
+    "gha_run_cancel",
+    {
+      mutates: "github_actions.run.cancel",
+      recoverable: true,
+      scopeTargetOf: (p) => ({ kind: "repo", value: `${p.owner}/${p.repo}` }),
+    },
+    "Cancel a workflow run.",
+    runIdSchema,
+    async (parsed) => {
+      const token = requireProcessEnv("GITHUB_PAT");
+      const path = `${ghRepoPath(parsed.owner, parsed.repo)}/actions/runs/${String(parsed.runId)}/cancel`;
+      const res = await ghFetch(token, path, { method: "POST" });
+      if (!res.ok) {
+        throw new Error(`GitHub Actions cancel ${String(res.status)}: ${res.text.slice(0, 400)}`);
+      }
+      return jsonResult({ ok: true, runId: parsed.runId });
+    },
+  );
+}

package/connectors/gitlab/src/server.ts

@@ -1,392 +1,10 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
-import { z } from "zod";
-import { createWriteToolRegistrar, type WriteToolConfig } from "../../../shared/consent-kit.ts";
-import {
-  createRegisterSimpleTool,
-  createZodToolRegistrar,
-  mcpJsonResult as jsonResult,
-  mcpJsonResultIfOk,
-  requireProcessEnv,
-  type ZodObjectSchema,
-} from "../../../shared/mcp-tool-kit.ts";
-import { stripTrailingSlashes } from "../../../shared/strip-trailing-slashes.ts";
-
-function apiBase(): string {
-  const b = process.env["GITLAB_API_BASE_URL"];
-  if (b !== undefined && b.trim() !== "") {
-    return stripTrailingSlashes(b);
-  }
-  return "https://gitlab.com/api/v4";
-}
-
-async function glFetch(
-  token: string,
-  path: string,
-  init?: RequestInit,
-): Promise<{ ok: boolean; status: number; json: unknown; text: string }> {
-  const base = apiBase();
-  const relativePath = path.startsWith("/") ? path : `/${path}`;
-  const url = path.startsWith("http") ? path : `${base}${relativePath}`;
-  const baseHeaders: Record<string, string> = { "PRIVATE-TOKEN": token };
-  const mergedHeaders =
-    init?.headers === undefined
-      ? baseHeaders
-      : { ...baseHeaders, ...(init.headers as Record<string, string>) };
-  const res = await fetch(url, {
-    ...init,
-    headers: mergedHeaders,
-  });
-  const text = await res.text();
-  let json: unknown;
-  try {
-    json = JSON.parse(text) as unknown;
-  } catch {
-    json = null;
-  }
-  return { ok: res.ok, status: res.status, json, text };
-}
+import { registerGitlabTools } from "./tools.ts";
 
 const server = new McpServer({ name: "nimbus-gitlab", version: "0.1.0" });
 
-const registerSimpleTool = createRegisterSimpleTool(server);
-const reg = createZodToolRegistrar(registerSimpleTool);
-
-/**
- * Register a standard GitLab read/write tool whose body is the repeated shape
- * `token → glFetch(buildUrl[, buildInit]) → mcpJsonResultIfOk("GitLab", res)`.
- * `buildUrl` returns the relative path (or absolute URL) and `buildInit` the
- * optional fetch init (method/body). Tools with a non-standard tail (raw text
- * trace, custom error text) stay hand-written below.
- */
-/**
- * Every MUTATING gitlab tool goes through here. Outside the gateway this adds the
- * consent gate, the write-scope allow-list, the mutation budget and the audit record; inside
- * the gateway it is a pass-through, because executor.ts (I2) is the gate there.
- */
-const registerWriteTool = createWriteToolRegistrar(server, {
-  connector: "gitlab",
-  scopeEnv: "NIMBUS_MCP_GITLAB_WRITE_SCOPE",
-  scopeKinds: ["repo"],
-});
-
-/**
- * The write-tool equivalent of `registerGitlabTool`: identical fetch and result handling, routed
- * through the write registrar. `scopeTargetOf` is supplied here rather than per tool — every
- * GitLab mutation is scoped to one project — so a new write tool cannot forget it.
- */
-function registerGitlabWriteTool<T extends { projectPath: string }>(
-  name: string,
-  cfg: Omit<WriteToolConfig<T>, "scopeTargetOf">,
-  description: string,
-  schema: ZodObjectSchema<T>,
-  buildUrl: (p: T) => string,
-  buildInit?: (p: T) => RequestInit,
-): void {
-  registerWriteTool(
-    name,
-    { ...cfg, scopeTargetOf: (p) => ({ kind: "repo", value: p.projectPath }) },
-    description,
-    schema,
-    async (parsed) => {
-      const token = requireProcessEnv("GITLAB_PAT");
-      const res = await glFetch(token, buildUrl(parsed), buildInit?.(parsed));
-      return mcpJsonResultIfOk("GitLab", res);
-    },
-  );
-}
-
-function registerGitlabTool<T>(
-  name: string,
-  description: string,
-  schema: ZodObjectSchema<T>,
-  buildUrl: (p: T) => string,
-  buildInit?: (p: T) => RequestInit,
-): void {
-  reg(name, description, schema, async (parsed) => {
-    const token = requireProcessEnv("GITLAB_PAT");
-    const res = await glFetch(token, buildUrl(parsed), buildInit?.(parsed));
-    return mcpJsonResultIfOk("GitLab", res);
-  });
-}
-
-const projectPathArg = z.object({
-  projectPath: z
-    .string()
-    .min(1)
-    .describe("URL-encoded path or numeric project id, e.g. group/repo"),
-});
-
-const gitlabProjectListSchema = z.object({
-  perPage: z.number().int().min(1).max(100).optional(),
-  page: z.number().int().min(1).optional(),
-});
-
-registerGitlabTool(
-  "gitlab_project_list",
-  "List projects visible to the authenticated user (membership).",
-  gitlabProjectListSchema,
-  (parsed) => {
-    const u = new URL(`${apiBase()}/projects`);
-    u.searchParams.set("membership", "true");
-    u.searchParams.set("order_by", "last_activity_at");
-    u.searchParams.set("sort", "desc");
-    u.searchParams.set("per_page", String(parsed.perPage ?? 30));
-    if (parsed.page !== undefined) {
-      u.searchParams.set("page", String(parsed.page));
-    }
-    // Absolute URL: u already includes apiBase()'s `/api/v4`; returning a
-    // relative path would let glFetch re-prefix apiBase() → `/api/v4/api/v4/…`.
-    return u.toString();
-  },
-);
-
-const gitlabMrListSchema = projectPathArg.extend({
-  state: z.enum(["opened", "closed", "locked", "merged", "all"]).optional(),
-  perPage: z.number().int().min(1).max(100).optional(),
-  page: z.number().int().min(1).optional(),
-});
-
-registerGitlabTool(
-  "gitlab_mr_list",
-  "List merge requests for a project.",
-  gitlabMrListSchema,
-  (parsed) => {
-    const enc = encodeURIComponent(parsed.projectPath);
-    const u = new URL(`${apiBase()}/projects/${enc}/merge_requests`);
-    u.searchParams.set("state", parsed.state ?? "opened");
-    u.searchParams.set("per_page", String(parsed.perPage ?? 30));
-    if (parsed.page !== undefined) {
-      u.searchParams.set("page", String(parsed.page));
-    }
-    // Absolute URL: u already includes apiBase()'s `/api/v4`; returning a
-    // relative path would let glFetch re-prefix apiBase() → `/api/v4/api/v4/…`.
-    return u.toString();
-  },
-);
-
-const gitlabMrGetSchema = projectPathArg.extend({
-  mergeRequestIid: z.number().int().min(1),
-});
-
-registerGitlabTool(
-  "gitlab_mr_get",
-  "Get a single merge request by IID.",
-  gitlabMrGetSchema,
-  (parsed) =>
-    `/projects/${encodeURIComponent(parsed.projectPath)}/merge_requests/${String(parsed.mergeRequestIid)}`,
-);
-
-const gitlabMrMergeSchema = projectPathArg.extend({
-  mergeRequestIid: z.number().int().min(1),
-  mergeCommitMessage: z.string().max(10_000).optional(),
-  squash: z.boolean().optional(),
-  shouldRemoveSourceBranch: z.boolean().optional(),
-});
-
-registerGitlabWriteTool(
-  "gitlab_mr_merge",
-  {
-    mutates: "gitlab.mr.merge",
-    recoverable: true,
-  },
-  "Merge a merge request.",
-  gitlabMrMergeSchema,
-  (parsed) =>
-    `/projects/${encodeURIComponent(parsed.projectPath)}/merge_requests/${String(parsed.mergeRequestIid)}/merge`,
-  (parsed) => {
-    const body: Record<string, unknown> = {};
-    if (parsed.mergeCommitMessage !== undefined) {
-      body["merge_commit_message"] = parsed.mergeCommitMessage;
-    }
-    if (parsed.squash !== undefined) {
-      body["squash"] = parsed.squash;
-    }
-    if (parsed.shouldRemoveSourceBranch !== undefined) {
-      body["should_remove_source_branch"] = parsed.shouldRemoveSourceBranch;
-    }
-    return {
-      method: "PUT",
-      headers: { "Content-Type": "application/json" },
-      body: JSON.stringify(body),
-    };
-  },
-);
-
-const gitlabIssueListSchema = projectPathArg.extend({
-  state: z.enum(["opened", "closed", "all"]).optional(),
-  perPage: z.number().int().min(1).max(100).optional(),
-  page: z.number().int().min(1).optional(),
-});
-
-registerGitlabTool(
-  "gitlab_issue_list",
-  "List issues for a project.",
-  gitlabIssueListSchema,
-  (parsed) => {
-    const enc = encodeURIComponent(parsed.projectPath);
-    const u = new URL(`${apiBase()}/projects/${enc}/issues`);
-    u.searchParams.set("state", parsed.state ?? "opened");
-    u.searchParams.set("per_page", String(parsed.perPage ?? 30));
-    if (parsed.page !== undefined) {
-      u.searchParams.set("page", String(parsed.page));
-    }
-    // Absolute URL: u already includes apiBase()'s `/api/v4`; returning a
-    // relative path would let glFetch re-prefix apiBase() → `/api/v4/api/v4/…`.
-    return u.toString();
-  },
-);
-
-const gitlabIssueGetSchema = projectPathArg.extend({
-  issueIid: z.number().int().min(1),
-});
-
-registerGitlabTool(
-  "gitlab_issue_get",
-  "Get a single issue by IID.",
-  gitlabIssueGetSchema,
-  (parsed) =>
-    `/projects/${encodeURIComponent(parsed.projectPath)}/issues/${String(parsed.issueIid)}`,
-);
-
-const gitlabPipelineListSchema = projectPathArg.extend({
-  ref: z.string().max(500).optional(),
-  status: z.string().max(64).optional(),
-  perPage: z.number().int().min(1).max(100).optional(),
-  page: z.number().int().min(1).optional(),
-});
-
-registerGitlabTool(
-  "gitlab_pipeline_list",
-  "List CI pipelines for a project.",
-  gitlabPipelineListSchema,
-  (parsed) => {
-    const enc = encodeURIComponent(parsed.projectPath);
-    const u = new URL(`${apiBase()}/projects/${enc}/pipelines`);
-    u.searchParams.set("per_page", String(parsed.perPage ?? 30));
-    if (parsed.page !== undefined) {
-      u.searchParams.set("page", String(parsed.page));
-    }
-    if (parsed.ref !== undefined) {
-      u.searchParams.set("ref", parsed.ref);
-    }
-    if (parsed.status !== undefined) {
-      u.searchParams.set("status", parsed.status);
-    }
-    // Absolute URL: u already includes apiBase()'s `/api/v4`; returning a
-    // relative path would let glFetch re-prefix apiBase() → `/api/v4/api/v4/…`.
-    return u.toString();
-  },
-);
-
-const gitlabPipelineGetSchema = projectPathArg.extend({
-  pipelineId: z.number().int().min(1),
-});
-
-registerGitlabTool(
-  "gitlab_pipeline_get",
-  "Get a single pipeline by id.",
-  gitlabPipelineGetSchema,
-  (parsed) =>
-    `/projects/${encodeURIComponent(parsed.projectPath)}/pipelines/${String(parsed.pipelineId)}`,
-);
-
-registerGitlabTool(
-  "gitlab_pipeline_jobs_get",
-  "List jobs for a CI pipeline (by pipeline id).",
-  gitlabPipelineGetSchema,
-  (parsed) =>
-    `/projects/${encodeURIComponent(parsed.projectPath)}/pipelines/${String(parsed.pipelineId)}/jobs`,
-);
-
-const gitlabJobTraceSchema = projectPathArg.extend({
-  jobId: z.number().int().min(1),
-});
-
-reg(
-  "gitlab_job_trace",
-  "Download plain-text trace for a CI job (by job id).",
-  gitlabJobTraceSchema,
-  async (parsed) => {
-    const token = requireProcessEnv("GITLAB_PAT");
-    const enc = encodeURIComponent(parsed.projectPath);
-    const url = `${apiBase()}/projects/${enc}/jobs/${String(parsed.jobId)}/trace`;
-    const res = await fetch(url, { headers: { "PRIVATE-TOKEN": token } });
-    const text = await res.text();
-    if (!res.ok) {
-      throw new Error(`GitLab ${String(res.status)}: ${text.slice(0, 300)}`);
-    }
-    return jsonResult({ trace: text });
-  },
-);
-
-reg(
-  "gitlab_job_log_tail",
-  "Download job trace text, optionally keeping only the last N characters (tail).",
-  gitlabJobTraceSchema.extend({
-    maxChars: z.number().int().min(1000).max(500_000).optional(),
-  }),
-  async (parsed) => {
-    const token = requireProcessEnv("GITLAB_PAT");
-    const enc = encodeURIComponent(parsed.projectPath);
-    const url = `${apiBase()}/projects/${enc}/jobs/${String(parsed.jobId)}/trace`;
-    const res = await fetch(url, { headers: { "PRIVATE-TOKEN": token } });
-    const text = await res.text();
-    if (!res.ok) {
-      throw new Error(`GitLab ${String(res.status)}: ${text.slice(0, 300)}`);
-    }
-    const max = parsed.maxChars ?? 64_000;
-    const tail = text.length > max ? text.slice(-max) : text;
-    return jsonResult({
-      jobId: parsed.jobId,
-      truncated: text.length > max,
-      totalChars: text.length,
-      trace: tail,
-    });
-  },
-);
-
-registerWriteTool(
-  "gitlab_pipeline_retry",
-  {
-    mutates: "gitlab.pipeline.retry",
-    recoverable: true,
-    scopeTargetOf: (p) => ({ kind: "repo", value: p.projectPath }),
-  },
-  "Retry failed jobs in a pipeline.",
-  gitlabPipelineGetSchema,
-  async (parsed) => {
-    const token = requireProcessEnv("GITLAB_PAT");
-    const enc = encodeURIComponent(parsed.projectPath);
-    const path = `/projects/${enc}/pipelines/${String(parsed.pipelineId)}/retry`;
-    const res = await glFetch(token, path, { method: "POST" });
-    if (!res.ok) {
-      throw new Error(`GitLab pipeline retry ${String(res.status)}: ${res.text.slice(0, 400)}`);
-    }
-    return mcpJsonResultIfOk("GitLab", res);
-  },
-);
-
-registerWriteTool(
-  "gitlab_pipeline_cancel",
-  {
-    mutates: "gitlab.pipeline.cancel",
-    recoverable: true,
-    scopeTargetOf: (p) => ({ kind: "repo", value: p.projectPath }),
-  },
-  "Cancel a pipeline.",
-  gitlabPipelineGetSchema,
-  async (parsed) => {
-    const token = requireProcessEnv("GITLAB_PAT");
-    const enc = encodeURIComponent(parsed.projectPath);
-    const path = `/projects/${enc}/pipelines/${String(parsed.pipelineId)}/cancel`;
-    const res = await glFetch(token, path, { method: "POST" });
-    if (!res.ok) {
-      throw new Error(`GitLab pipeline cancel ${String(res.status)}: ${res.text.slice(0, 400)}`);
-    }
-    return mcpJsonResultIfOk("GitLab", res);
-  },
-);
+registerGitlabTools(server);
 
 const transport = new StdioServerTransport();
 await server.connect(transport);