Initial work on stdio

README.md

@@ -9,6 +9,26 @@ It is based on [Cloudflare's work towards remote MCPs](https://blog.cloudflare.c
 
 ## Getting Started
 
+### Stdio vs Remote
+
+While this repository is primarily servicing a remote MCP use-case, we also support a stdio transport.
+
+Note: This is currently a draft and not available via a distribution.
+
+You will need to ensure your token is provisioned with the necessary scopes. As of writing this is:
+
+```
+org:read project:read project:write team:read team:write event:read
+```
+
+You can find the canonical reference to the needed scopes in the [source code](https://github.com/getsentry/sentry-mcp/blob/main/src/routes/auth.ts).
+
+Launching the stdio transport will just require you to bind `SENTRY_AUTH_TOKEN` and run the provided script:
+
+```shell
+SENTRY_AUTH_TOKEN= npm run start:stdio
+```
+
 ### Self-Hosted Sentry
 
 You can override the `SENTRY_URL` env variable to set your base Sentry url:

package.json

@@ -3,13 +3,15 @@
   "version": "0.0.1",
   "private": true,
   "scripts": {
+    "build": "tsc",
     "deploy": "wrangler deploy",
     "dev": "wrangler dev",
     "format": "biome format --write",
     "lint": "biome lint",
     "lint:fix": "biome lint --fix",
     "inspector": "pnpx @modelcontextprotocol/inspector@latest",
     "start": "wrangler dev",
+    "start:stdio": "tsx dist/mcp/start-stdio.js",
     "cf-typegen": "wrangler types",
     "postinstall": "simple-git-hooks",
     "test": "vitest",
@@ -43,7 +45,7 @@
     "pre-commit": "pnpm exec lint-staged --concurrent false"
   },
   "lint-staged": {
-    "*": ["biome format --write"],
+    "**/*.{ts,tsx,json}": ["biome format --write"],
     "**/*.{ts,tsx}": ["biome lint --fix"]
   }
 }

src/index.ts

@@ -1,16 +1,16 @@
 import { withSentry } from "@sentry/cloudflare";
 import OAuthProvider from "@cloudflare/workers-oauth-provider";
 import app from "./app";
-import SentryMCP from "./mcp/server";
+import SentryMCPWorker from "./mcp/transports/cloudflare-worker";
 import { SCOPES } from "./routes/auth";
 
 // required for Durable Objects
-export { default as SentryMCP } from "./mcp/server";
+export { SentryMCPWorker };
 
 const oAuthProvider = new OAuthProvider({
   apiRoute: "/sse",
   // @ts-ignore
-  apiHandler: SentryMCP.mount("/sse"),
+  apiHandler: SentryMCPWorker.mount("/sse"),
   // @ts-ignore
   defaultHandler: app,
   authorizeEndpoint: "/authorize",

src/mcp/server.ts

@@ -1,55 +1,49 @@
-import { McpAgent } from "agents/mcp";
-import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
-import type { Props } from "../types";
+import type { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { ServerContext } from "../types";
 import { logError } from "../lib/logging";
 import { TOOL_DEFINITIONS, TOOL_HANDLERS } from "./tools";
 
-// Context from the auth process, encrypted & stored in the auth token
-// and provided to the DurableMCP as this.props
-export default class SentryMCP extends McpAgent<Env, unknown, Props> {
-  server = new McpServer({
-    name: "Sentry MCP",
-    version: "0.1.0",
-  });
+export function configureServer(server: McpServer, context: ServerContext) {
+  server.server.onerror = (error) => {
+    logError(error);
+  };
 
-  async init() {
-    for (const tool of TOOL_DEFINITIONS) {
-      const handler = TOOL_HANDLERS[tool.name];
+  for (const tool of TOOL_DEFINITIONS) {
+    const handler = TOOL_HANDLERS[tool.name];
 
-      this.server.tool(
-        tool.name as string,
-        tool.description,
-        tool.paramsSchema ? tool.paramsSchema : {},
-        async (...args) => {
-          try {
-            // TODO(dcramer): I'm too dumb to figure this out
-            // @ts-ignore
-            const output = await handler(this.props, ...args);
+    server.tool(
+      tool.name as string,
+      tool.description,
+      tool.paramsSchema ? tool.paramsSchema : {},
+      async (...args) => {
+        try {
+          // TODO(dcramer): I'm too dumb to figure this out
+          // @ts-ignore
+          const output = await handler(context, ...args);
 
-            return {
-              content: [
-                {
-                  type: "text",
-                  text: output,
-                },
-              ],
-            };
-          } catch (error) {
-            logError(error);
-            return {
-              content: [
-                {
-                  type: "text",
-                  text: `**Error**\n\nIt looks like there was a problem communicating with the Sentry API:\n\n${
-                    error instanceof Error ? error.message : String(error)
-                  }`,
-                },
-              ],
-              isError: true,
-            };
-          }
-        },
-      );
-    }
+          return {
+            content: [
+              {
+                type: "text",
+                text: output,
+              },
+            ],
+          };
+        } catch (error) {
+          logError(error);
+          return {
+            content: [
+              {
+                type: "text",
+                text: `**Error**\n\nIt looks like there was a problem communicating with the Sentry API:\n\n${
+                  error instanceof Error ? error.message : String(error)
+                }`,
+              },
+            ],
+            isError: true,
+          };
+        }
+      },
+    );
   }
 }

src/mcp/start-stdio.ts

@@ -0,0 +1,26 @@
+#!/usr/bin/env node
+
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { startStdio } from "./transports/stdio.js";
+
+const accessToken = process.env.SENTRY_AUTH_TOKEN;
+
+if (!accessToken) {
+  console.error("SENTRY_AUTH_TOKEN is not set");
+  process.exit(1);
+}
+
+const server = new McpServer({
+  name: "Sentry MCP",
+  version: "0.1.0",
+});
+
+// XXX: we could do what we're doing in routes/auth.ts and pass the context
+// identically, but we don't really need userId and userName yet
+startStdio(server, {
+  accessToken,
+  organizationSlug: null,
+}).catch((err) => {
+  console.error("Server error:", err);
+  process.exit(1);
+});

src/mcp/tools.ts

@@ -1,4 +1,4 @@
-import type { Props } from "../types";
+import type { ServerContext } from "../types";
 import { z } from "zod";
 import type {
   SentryErrorEntrySchema,
@@ -66,7 +66,7 @@
       "- View all teams in a Sentry organization",
     ].join("\n"),
     paramsSchema: {
-      organizationSlug: ParamOrganizationSlug,
+      organizationSlug: ParamOrganizationSlug.optional(),
     },
   },
   {
@@ -78,7 +78,7 @@
       "- View all projects in a Sentry organization",
     ].join("\n"),
     paramsSchema: {
-      organizationSlug: ParamOrganizationSlug,
+      organizationSlug: ParamOrganizationSlug.optional(),
     },
   },
   {
@@ -131,7 +131,7 @@
       "- Create a new team in a Sentry organization",
     ].join("\n"),
     paramsSchema: {
-      organizationSlug: ParamOrganizationSlug,
+      organizationSlug: ParamOrganizationSlug.optional(),
       name: z.string().describe("The name of the team to create."),
     },
   },
@@ -178,7 +178,7 @@
 ) => Promise<string>;
 
 export type ToolHandlerExtended<T extends ToolName> = (
-  props: Props,
+  context: ServerContext,
   params: ToolParams<T>,
   extra: RequestHandlerExtra,
 ) => Promise<string>;
@@ -188,20 +188,24 @@
 };
 
 export const TOOL_HANDLERS = {
-  list_organizations: async (props) => {
-    const apiService = new SentryApiService(props.accessToken);
+  list_organizations: async (context) => {
+    const apiService = new SentryApiService(context.accessToken);
     const organizations = await apiService.listOrganizations();
 
     let output = "# Organizations\n\n";
     output += organizations.map((org) => `- ${org.slug}\n`).join("");
 
     return output;
   },
-  list_teams: async (props, { organizationSlug }) => {
-    const apiService = new SentryApiService(props.accessToken);
+  list_teams: async (context, { organizationSlug }) => {
+    const apiService = new SentryApiService(context.accessToken);
+
+    if (!organizationSlug && context.organizationSlug) {
+      organizationSlug = context.organizationSlug;
+    }
 
     if (!organizationSlug) {
-      organizationSlug = props.organizationSlug;
+      throw new Error("Organization slug is required");
     }
 
     const teams = await apiService.listTeams(organizationSlug);
@@ -211,11 +215,15 @@
 
     return output;
   },
-  list_projects: async (props, { organizationSlug }) => {
-    const apiService = new SentryApiService(props.accessToken);
+  list_projects: async (context, { organizationSlug }) => {
+    const apiService = new SentryApiService(context.accessToken);
+
+    if (!organizationSlug && context.organizationSlug) {
+      organizationSlug = context.organizationSlug;
+    }
 
     if (!organizationSlug) {
-      organizationSlug = props.organizationSlug;
+      throw new Error("Organization slug is required");
     }
 
     const projects = await apiService.listProjects(organizationSlug);
@@ -225,8 +233,11 @@
 
     return output;
   },
-  get_error_details: async (props, { issueId, issueUrl, organizationSlug }) => {
-    const apiService = new SentryApiService(props.accessToken);
+  get_error_details: async (
+    context,
+    { issueId, issueUrl, organizationSlug },
+  ) => {
+    const apiService = new SentryApiService(context.accessToken);
 
     if (issueUrl) {
       const resolved = extractIssueId(issueUrl);
@@ -241,8 +252,12 @@
       throw new Error("Either issueId or issueUrl must be provided");
     }
 
+    if (!organizationSlug && context.organizationSlug) {
+      organizationSlug = context.organizationSlug;
+    }
+
     if (!organizationSlug) {
-      organizationSlug = props.organizationSlug;
+      throw new Error("Organization slug is required");
     }
 
     const event = await apiService.getLatestEventForIssue({
@@ -269,13 +284,17 @@
   },
 
   search_errors_in_file: async (
-    props,
+    context,
     { filename, sortBy, organizationSlug },
   ) => {
-    const apiService = new SentryApiService(props.accessToken);
+    const apiService = new SentryApiService(context.accessToken);
+
+    if (!organizationSlug && context.organizationSlug) {
+      organizationSlug = context.organizationSlug;
+    }
 
     if (!organizationSlug) {
-      organizationSlug = props.organizationSlug;
+      throw new Error("Organization slug is required");
     }
 
     const eventList = await apiService.searchErrors({
@@ -305,11 +324,15 @@
     return output;
   },
 
-  create_team: async (props, { organizationSlug, name }) => {
-    const apiService = new SentryApiService(props.accessToken);
+  create_team: async (context, { organizationSlug, name }) => {
+    const apiService = new SentryApiService(context.accessToken);
+
+    if (!organizationSlug && context.organizationSlug) {
+      organizationSlug = context.organizationSlug;
+    }
 
     if (!organizationSlug) {
-      organizationSlug = props.organizationSlug;
+      throw new Error("Organization slug is required");
     }
 
     const team = await apiService.createTeam({
@@ -326,13 +349,17 @@
   },
 
   create_project: async (
-    props,
+    context,
     { organizationSlug, teamSlug, name, platform },
   ) => {
-    const apiService = new SentryApiService(props.accessToken);
+    const apiService = new SentryApiService(context.accessToken);
+
+    if (!organizationSlug && context.organizationSlug) {
+      organizationSlug = context.organizationSlug;
+    }
 
     if (!organizationSlug) {
-      organizationSlug = props.organizationSlug;
+      throw new Error("Organization slug is required");
     }
 
     const [project, clientKey] = await apiService.createProject({

src/mcp/transports/cloudflare-worker.ts

@@ -0,0 +1,21 @@
+import { McpAgent } from "agents/mcp";
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import type { WorkerProps } from "../../types";
+import { configureServer } from "../server";
+
+// Context from the auth process, encrypted & stored in the auth token
+// and provided to the DurableMCP as this.props
+export default class SentryMCPWorker extends McpAgent<
+  Env,
+  unknown,
+  WorkerProps
+> {
+  server = new McpServer({
+    name: "Sentry MCP",
+    version: "0.1.0",
+  });
+
+  async init() {
+    configureServer(this.server, this.props);
+  }
+}