diff --git a/packages/mcp-core/package.json b/packages/mcp-core/package.json index b43b0b86cb..adbd9a2ff1 100644 --- a/packages/mcp-core/package.json +++ b/packages/mcp-core/package.json @@ -160,6 +160,7 @@ "test:watch": "pnpm run generate-definitions && vitest", "tsc": "tsc --noEmit", "generate-definitions": "node --experimental-strip-types --import ../../scripts/strip-types-resolve.mjs scripts/generate-definitions.ts && oxfmt --write src/toolDefinitions.json src/skillDefinitions.json", + "generate-platform-setup": "node --experimental-strip-types --import ../../scripts/strip-types-resolve.mjs scripts/generate-platform-setup.ts && oxfmt --write src/tools/support/project-setup/platforms.json", "generate-otel-namespaces": "node --experimental-strip-types --import ../../scripts/strip-types-resolve.mjs scripts/generate-otel-namespaces.ts", "measure-tokens": "node --experimental-strip-types --import ../../scripts/strip-types-resolve.mjs scripts/measure-token-cost.ts", "validate-skills": "node --experimental-strip-types --import ../../scripts/strip-types-resolve.mjs scripts/validate-skills-mapping.ts" diff --git a/packages/mcp-core/scripts/generate-platform-setup.ts b/packages/mcp-core/scripts/generate-platform-setup.ts new file mode 100644 index 0000000000..0f4b81d908 --- /dev/null +++ b/packages/mcp-core/scripts/generate-platform-setup.ts @@ -0,0 +1,243 @@ +/** + * Generates src/tools/support/project-setup/platforms.json: for each Sentry + * platform ID, its display name, its setup docs page, and the docs page of + * each core signal (traces, logs, metrics, session replay) that its SDK + * supports. `create_project` returns this as setup knowledge. + * + * Sources: + * - getsentry/sentry static/app/data/platforms.tsx: platform IDs, names, + * and docs links, the same list Sentry's project creation uses. + * - docs.sentry.io/doctree.json: the published docs tree. A platform page + * has a `tracing`, `logs`, `metrics`, or `session-replay` child only when + * the docs say its SDK supports that signal. + * + * Usage (from packages/mcp-core): + * pnpm run generate-platform-setup + * + * The output is committed. Rerun this when Sentry adds a platform or the docs + * change which signals a platform supports. + */ +import { writeFileSync } from "node:fs"; +import { dirname, resolve } from "node:path"; +import { fileURLToPath } from "node:url"; +import { z } from "zod"; + +const __dirname = dirname(fileURLToPath(import.meta.url)); + +const PLATFORMS_URL = + "https://raw.githubusercontent.com/getsentry/sentry/master/static/app/data/platforms.tsx"; +const DOCS_ORIGIN = "https://docs.sentry.io"; +const OUTPUT_PATH = resolve( + __dirname, + "../src/tools/support/project-setup/platforms.json", +); + +// Docs child page slug for each signal, in the order the result lists them. +const SIGNAL_PAGES = { + traces: "tracing", + logs: "logs", + metrics: "metrics", + sessionReplay: "session-replay", +} as const; + +type SignalKey = keyof typeof SIGNAL_PAGES; + +// Platforms whose link in platforms.tsx points at a broader page than the +// platform's own guide. Mirrors CANONICAL_OVERRIDES in getsentry/sentry +// scripts/genPlatformProductInfo.ts. +const DOCS_PATH_OVERRIDES: Record = { + "apple-ios": "/platforms/apple/guides/ios/", + "apple-macos": "/platforms/apple/guides/macos/", +}; + +interface DocTreeNode { + path: string; + slug: string; + frontmatter?: { + title?: string; + fallbackGuide?: string; + sidebar_hidden?: boolean; + }; + children?: DocTreeNode[]; +} + +const DocTreeNodeSchema: z.ZodType = z.lazy(() => + z.object({ + path: z.string(), + slug: z.string(), + frontmatter: z + .object({ + title: z.string().optional(), + fallbackGuide: z.string().optional(), + sidebar_hidden: z.boolean().optional(), + }) + .optional(), + children: z.array(DocTreeNodeSchema).optional(), + }), +); + +interface PlatformEntry { + id: string; + name: string; + link: string; +} + +interface PlatformSetupEntry { + name: string; + docsUrl: string; + signals: Partial>; +} + +function readField(block: string, field: string): string | undefined { + return block.match( + new RegExp(`(?:^|\\n)\\s*${field}:\\s*['"]([^'"]*)['"]`), + )?.[1]; +} + +/** Reads the static `platforms` array literal from platforms.tsx. */ +function parsePlatforms(source: string): PlatformEntry[] { + const body = source.split("export const platforms")[1]?.split("\n];")[0]; + if (!body) { + throw new Error("platforms array not found in platforms.tsx"); + } + const platforms: PlatformEntry[] = []; + for (const block of body.split(/\n {2}\{\n/).slice(1)) { + const id = readField(block, "id"); + const name = readField(block, "name"); + const link = readField(block, "link"); + if (!id || !name || !link || /\n\s*deprecated:\s*true/.test(block)) { + continue; + } + platforms.push({ id, name, link }); + } + if (platforms.length === 0) { + throw new Error("no platforms parsed from platforms.tsx"); + } + return platforms; +} + +function normalizePath(path: string): string { + return path.replace(/^\/+|\/+$/g, ""); +} + +function indexDocTree(root: DocTreeNode): Map { + const index = new Map(); + const visit = (node: DocTreeNode) => { + if (node.frontmatter?.sidebar_hidden) { + return; + } + index.set(normalizePath(node.path), node); + for (const child of node.children ?? []) { + visit(child); + } + }; + visit(root); + return index; +} + +function hasSignalPages(node: DocTreeNode): boolean { + const pages = new Set(Object.values(SIGNAL_PAGES)); + return (node.children ?? []).some((child) => pages.has(child.slug)); +} + +/** + * Finds the page whose children list the signals for a platform page. Guides + * that share another guide's SDK, such as Express on Node.js, name it in + * `fallbackGuide`. Integration pages, such as Django under Python, inherit + * from the nearest ancestor that lists signals. + */ +function findSignalSource( + index: Map, + path: string, +): DocTreeNode | null { + const node = index.get(path); + if (!node) { + return null; + } + if (hasSignalPages(node)) { + return node; + } + const fallbackGuide = node.frontmatter?.fallbackGuide; + if (fallbackGuide) { + const [lang, guide] = fallbackGuide.split("."); + const fallback = index.get(`platforms/${lang}/guides/${guide}`); + if (fallback && hasSignalPages(fallback)) { + return fallback; + } + } + const segments = path.split("/"); + while (segments.length > 2) { + segments.pop(); + const ancestor = index.get(segments.join("/")); + if (ancestor && hasSignalPages(ancestor)) { + return ancestor; + } + } + return node; +} + +async function resolveRedirects(path: string): Promise { + const response = await fetch(new URL(path, DOCS_ORIGIN), { + method: "HEAD", + redirect: "follow", + }); + return new URL(response.url).pathname; +} + +async function fetchText(url: string): Promise { + const response = await fetch(url); + if (!response.ok) { + throw new Error(`GET ${url} failed with ${response.status}`); + } + return await response.text(); +} + +async function main() { + const [platformsSource, docTreeText] = await Promise.all([ + fetchText(PLATFORMS_URL), + fetchText(`${DOCS_ORIGIN}/doctree.json`), + ]); + const platforms = parsePlatforms(platformsSource); + const index = indexDocTree(DocTreeNodeSchema.parse(JSON.parse(docTreeText))); + + const output: Record = {}; + const skipped: string[] = []; + for (const platform of platforms) { + const linkPath = + DOCS_PATH_OVERRIDES[platform.id] ?? new URL(platform.link).pathname; + const path = normalizePath(await resolveRedirects(linkPath)); + // The platform list page is not a setup guide (for example `other`). + if (path === "platforms" || !index.has(path)) { + skipped.push(`${platform.id} (${path})`); + continue; + } + const source = findSignalSource(index, path); + const childSlugs = new Set( + (source?.children ?? []).map((child) => child.slug), + ); + const signals: Partial> = {}; + for (const [key, slug] of Object.entries(SIGNAL_PAGES) as [ + SignalKey, + string, + ][]) { + if (source && childSlugs.has(slug)) { + signals[key] = `${DOCS_ORIGIN}/${normalizePath(source.path)}/${slug}/`; + } + } + output[platform.id] = { + name: platform.name, + docsUrl: `${DOCS_ORIGIN}/${path}/`, + signals, + }; + } + + writeFileSync(OUTPUT_PATH, `${JSON.stringify(output, null, 2)}\n`); + console.log( + `Wrote ${Object.keys(output).length} platforms to ${OUTPUT_PATH}`, + ); + if (skipped.length > 0) { + console.log(`Skipped (no docs setup page): ${skipped.join(", ")}`); + } +} + +await main(); diff --git a/packages/mcp-core/src/skillDefinitions.json b/packages/mcp-core/src/skillDefinitions.json index a7701bc123..cd770a91c3 100644 --- a/packages/mcp-core/src/skillDefinitions.json +++ b/packages/mcp-core/src/skillDefinitions.json @@ -585,7 +585,7 @@ }, { "name": "create_project", - "description": "Create a new Sentry project for an app or service and provision its DSN (client key) for SDK setup. Optionally links a connected repository with a root code mapping. Returns the project, its DSN, and whether the repository linked.", + "description": "Create a new Sentry project for an app or service and provision its DSN (client key) for SDK setup. Optionally links a connected repository with a root code mapping. Returns the project, its DSN, whether the repository linked, and the Sentry signals its platform supports, each with a docs link.", "requiredScopes": ["project:write", "team:read", "org:read"] }, { diff --git a/packages/mcp-core/src/toolDefinitions.json b/packages/mcp-core/src/toolDefinitions.json index 0965114a63..53f80c5dfd 100644 --- a/packages/mcp-core/src/toolDefinitions.json +++ b/packages/mcp-core/src/toolDefinitions.json @@ -1218,7 +1218,7 @@ { "name": "create_project", "title": "Create Project", - "description": "Create a new Sentry project for an app or service and provision its DSN (client key) for SDK setup. Optionally links a connected repository with a root code mapping. Returns the project, its DSN, and whether the repository linked.", + "description": "Create a new Sentry project for an app or service and provision its DSN (client key) for SDK setup. Optionally links a connected repository with a root code mapping. Returns the project, its DSN, whether the repository linked, and the Sentry signals its platform supports, each with a docs link.", "inputSchema": { "type": "object", "properties": { @@ -1321,11 +1321,83 @@ } ] }, - "guidance": { - "type": "string" + "setup": { + "anyOf": [ + { + "type": "object", + "properties": { + "platform": { + "type": "string", + "description": "Platform display name, such as `Next.js`." + }, + "docsUrl": { + "type": "string", + "description": "Sentry setup guide for the platform." + }, + "signals": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "usefulFor": { + "type": "string" + }, + "recommended": { + "description": "Set on signals the SDK's default setup turns on.", + "type": "boolean", + "const": true + }, + "docsUrl": { + "type": "string" + } + }, + "required": ["name", "usefulFor", "docsUrl"], + "additionalProperties": false + }, + "description": "Core signals the platform supports and the organization has enabled." + } + }, + "required": ["platform", "docsUrl", "signals"], + "additionalProperties": false + }, + { + "type": "null" + } + ], + "description": "Setup knowledge for the project's platform, or null without one." + }, + "suggestedActions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "const": "tool_call" + }, + "toolName": { + "type": "string" + }, + "arguments": { + "type": "object", + "propertyNames": { + "type": "string" + }, + "additionalProperties": {} + }, + "reason": { + "type": "string" + } + }, + "required": ["type", "toolName", "arguments", "reason"], + "additionalProperties": false + } } }, - "required": ["project", "dsn", "repository", "guidance"], + "required": ["project", "dsn", "repository", "setup", "suggestedActions"], "additionalProperties": false }, "requiredScopes": ["project:write", "team:read", "org:read"], diff --git a/packages/mcp-core/src/tools/catalog/create-project.test.ts b/packages/mcp-core/src/tools/catalog/create-project.test.ts index 4d7d3b6324..3da2813548 100644 --- a/packages/mcp-core/src/tools/catalog/create-project.test.ts +++ b/packages/mcp-core/src/tools/catalog/create-project.test.ts @@ -1,6 +1,7 @@ import { clientKeyFixture, mswServer, + organizationFixture, projectFixture, } from "@sentry/mcp-server-mocks"; import { http, HttpResponse } from "msw"; @@ -59,13 +60,41 @@ describe("create_project", () => { expect(output).toMatchInlineSnapshot(` { "dsn": "https://d20df0a1ab5031c7f3c7edca9c02814d@o4509106732793856.ingest.us.sentry.io/4509109104082945", - "guidance": "Tell the user the project slug and DSN; the SDK needs the DSN.", "project": { "id": "4509109104082945", "name": "cloudflare-mcp", "slug": "cloudflare-mcp", }, "repository": null, + "setup": { + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/node/", + "platform": "Node.js", + "signals": [ + { + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/node/", + "name": "Errors", + "recommended": true, + "usefulFor": "Unhandled exceptions and crashes, grouped into issues with stack traces and the state that led to them", + }, + { + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/node/tracing/", + "name": "Traces", + "recommended": true, + "usefulFor": "Debugging how requests, background jobs, and AI agent runs flow across services, and where they fail or slow down", + }, + { + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/node/logs/", + "name": "Logs", + "usefulFor": "Structured app logs linked to the trace and error they came from, for context a stack trace lacks", + }, + { + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/node/metrics/", + "name": "Metrics", + "usefulFor": "Counters, gauges, and distributions to chart and alert on, such as signups, queue depth, or token usage", + }, + ], + }, + "suggestedActions": [], } `); // Only the public DSN is exposed; secret keys and other key metadata stay private. @@ -260,7 +289,264 @@ describe("create_project", () => { project: { slug: "cloudflare-mcp" }, dsn: null, repository: null, - guidance: expect.stringContaining("Create one with create_dsn."), + suggestedActions: [ + { + type: "tool_call", + toolName: "create_dsn", + arguments: { + organizationSlug: "sentry-mcp-evals", + projectSlug: "cloudflare-mcp", + name: "Default", + }, + }, + ], + }); + }); + + it("keeps the region in the create_dsn suggestion when DSN setup fails", async () => { + mswServer.use( + http.post( + "https://us.sentry.io/api/0/teams/sentry-mcp-evals/the-goats/projects/", + () => HttpResponse.json(projectFixture), + ), + http.get( + "https://us.sentry.io/api/0/projects/sentry-mcp-evals/cloudflare-mcp/keys/", + () => HttpResponse.json({ detail: "lookup failed" }, { status: 500 }), + ), + http.post( + "https://us.sentry.io/api/0/projects/sentry-mcp-evals/cloudflare-mcp/keys/", + () => HttpResponse.json({ detail: "create failed" }, { status: 500 }), + ), + http.get( + "https://us.sentry.io/api/0/organizations/sentry-mcp-evals/", + () => HttpResponse.json(organizationFixture), + ), + ); + + const result = await createProject.handler( + { + organizationSlug: "sentry-mcp-evals", + teamSlug: "the-goats", + name: "cloudflare-mcp", + slug: null, + platform: "node", + regionUrl: "https://us.sentry.io", + repository: null, + }, + context, + ); + + expect(getOutput(result).suggestedActions).toEqual([ + { + type: "tool_call", + toolName: "create_dsn", + arguments: { + organizationSlug: "sentry-mcp-evals", + regionUrl: "https://us.sentry.io", + projectSlug: "cloudflare-mcp", + name: "Default", + }, + reason: "The project was created without a DSN.", + }, + ]); + }); + + it("lists only the setup signals the organization has enabled", async () => { + mswServer.use( + http.post( + "https://sentry.io/api/0/teams/sentry-mcp-evals/the-goats/projects/", + () => + HttpResponse.json({ + ...projectFixture, + platform: "javascript-nextjs", + }), + ), + http.get( + "https://sentry.io/api/0/organizations/sentry-mcp-evals/", + ({ request }) => { + expect( + new URL(request.url).searchParams.get("include_feature_flags"), + ).toBe("1"); + return HttpResponse.json({ + ...organizationFixture, + features: ["session-replay", "ourlogs-enabled"], + }); + }, + ), + ); + + const result = await createProject.handler( + { + organizationSlug: "sentry-mcp-evals", + teamSlug: "the-goats", + name: "cloudflare-mcp", + slug: null, + platform: "javascript-nextjs", + regionUrl: null, + repository: null, + }, + context, + ); + + expect(getOutput(result).setup).toMatchInlineSnapshot(` + { + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/nextjs/", + "platform": "Next.js", + "signals": [ + { + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/nextjs/", + "name": "Errors", + "recommended": true, + "usefulFor": "Unhandled exceptions and crashes, grouped into issues with stack traces and the state that led to them", + }, + { + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/nextjs/tracing/", + "name": "Traces", + "recommended": true, + "usefulFor": "Debugging how requests, background jobs, and AI agent runs flow across services, and where they fail or slow down", + }, + { + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/nextjs/logs/", + "name": "Logs", + "usefulFor": "Structured app logs linked to the trace and error they came from, for context a stack trace lacks", + }, + { + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/nextjs/session-replay/", + "name": "Session Replay", + "usefulFor": "Understanding how users behave in a web or mobile UI: clicks, navigation, network calls, and errors in a replay, to reproduce bugs and find friction", + }, + ], + } + `); + }); + + it("lists every supported setup signal when organization features fail to load", async () => { + mswServer.use( + http.get("https://sentry.io/api/0/organizations/sentry-mcp-evals/", () => + HttpResponse.json({ detail: "lookup failed" }, { status: 500 }), + ), + ); + + const result = await createProject.handler( + { + organizationSlug: "sentry-mcp-evals", + teamSlug: "the-goats", + name: "cloudflare-mcp", + slug: null, + platform: "node", + regionUrl: null, + repository: null, + }, + context, + ); + + const output = getOutput(result); + expect(output.dsn).not.toBeNull(); + expect(output.setup?.signals.map((signal) => signal.name)).toEqual([ + "Errors", + "Traces", + "Logs", + "Metrics", + ]); + }); + + it("returns no setup knowledge without a platform", async () => { + let organizationRequested = false; + mswServer.use( + http.post( + "https://sentry.io/api/0/teams/sentry-mcp-evals/the-goats/projects/", + () => HttpResponse.json({ ...projectFixture, platform: null }), + ), + http.get( + "https://sentry.io/api/0/organizations/sentry-mcp-evals/", + () => { + organizationRequested = true; + return HttpResponse.json(organizationFixture); + }, + ), + ); + + const result = await createProject.handler( + { + organizationSlug: "sentry-mcp-evals", + teamSlug: "the-goats", + name: "cloudflare-mcp", + slug: null, + platform: null, + regionUrl: null, + repository: null, + }, + context, + ); + + expect(getOutput(result)).toMatchObject({ + setup: null, + suggestedActions: [], + }); + expect(organizationRequested).toBe(false); + }); + + it("uses the created project's platform when none is passed", async () => { + mswServer.use( + http.post( + "https://sentry.io/api/0/teams/sentry-mcp-evals/the-goats/projects/", + () => + HttpResponse.json({ ...projectFixture, platform: "python-django" }), + ), + ); + + const result = await createProject.handler( + { + organizationSlug: "sentry-mcp-evals", + teamSlug: "the-goats", + name: "cloudflare-mcp", + slug: null, + platform: null, + regionUrl: null, + repository: null, + }, + context, + ); + + const setup = getOutput(result).setup; + expect(setup).toMatchObject({ + platform: "Django", + docsUrl: "https://docs.sentry.io/platforms/python/integrations/django/", + }); + // Integration pages take their signals from the Python SDK page. + expect(setup?.signals.map((signal) => signal.docsUrl)).toEqual([ + "https://docs.sentry.io/platforms/python/integrations/django/", + "https://docs.sentry.io/platforms/python/tracing/", + "https://docs.sentry.io/platforms/python/logs/", + "https://docs.sentry.io/platforms/python/metrics/", + ]); + }); + + it("returns no setup knowledge for a platform without a setup guide", async () => { + mswServer.use( + http.post( + "https://sentry.io/api/0/teams/sentry-mcp-evals/the-goats/projects/", + () => HttpResponse.json({ ...projectFixture, platform: "other" }), + ), + ); + + const result = await createProject.handler( + { + organizationSlug: "sentry-mcp-evals", + teamSlug: "the-goats", + name: "cloudflare-mcp", + slug: null, + platform: "other", + regionUrl: null, + repository: null, + }, + context, + ); + + expect(getOutput(result)).toMatchObject({ + dsn: expect.any(String), + setup: null, + suggestedActions: [], }); }); @@ -437,7 +723,7 @@ describe("create_project", () => { project: { slug: "cloudflare-mcp" }, dsn: expect.any(String), repository: { name: "getsentry/sentry", linked: false }, - guidance: expect.stringContaining("The repository did not link."), + suggestedActions: [], }); }); diff --git a/packages/mcp-core/src/tools/catalog/create-project.ts b/packages/mcp-core/src/tools/catalog/create-project.ts index 75e5f5d641..f0c83862de 100644 --- a/packages/mcp-core/src/tools/catalog/create-project.ts +++ b/packages/mcp-core/src/tools/catalog/create-project.ts @@ -4,6 +4,10 @@ import { UserInputError } from "../../errors"; import { apiServiceFromContext } from "../../internal/tool-helpers/api"; import { defineTool } from "../../internal/tool-helpers/define"; import { structuredResult } from "../../internal/tool-helpers/results"; +import { + buildSuggestedToolAction, + suggestedToolActionSchema, +} from "../../internal/tool-helpers/suggested-actions"; import { ParamOrganizationSlug, ParamPlatform, @@ -14,6 +18,10 @@ import { import { logWarn } from "../../telem/logging"; import { setTargetTagsAndAttributes } from "../../telem/scope"; import type { ServerContext } from "../../types"; +import { + buildProjectSetup, + projectSetupSchema, +} from "../support/project-setup/project-setup"; export const createProjectOutputSchema = z.object({ project: z.object({ @@ -33,7 +41,8 @@ export const createProjectOutputSchema = z.object({ linked: z.boolean(), }) .nullable(), - guidance: z.string(), + setup: projectSetupSchema, + suggestedActions: z.array(suggestedToolActionSchema), }); type RepositoryMatch = { @@ -84,6 +93,29 @@ function getRepositoryProvider(repository: RepositoryMatch): string | null { return repository.provider.id.replace(/^integrations:/, "") || null; } +async function getOrganizationFeatures({ + apiService, + organizationSlug, +}: { + apiService: SentryApiService; + organizationSlug: string; +}): Promise { + try { + // Sentry omits `features` unless explicitly requested. + const organization = await apiService.getOrganization(organizationSlug, { + includeFeatureFlags: true, + detailed: false, + }); + return organization.features ?? null; + } catch (err) { + logWarn(err, { + loggerScope: ["runtime", "project-management"], + extra: { action: "get_organization_features" }, + }); + return null; + } +} + async function getOrCreateClientKey({ apiService, organizationSlug, @@ -134,7 +166,7 @@ export default defineTool({ skills: ["project-management"], // Only available in project-management skill requiredScopes: ["project:write", "team:read", "org:read"], description: - "Create a new Sentry project for an app or service and provision its DSN (client key) for SDK setup. Optionally links a connected repository with a root code mapping. Returns the project, its DSN, and whether the repository linked.", + "Create a new Sentry project for an app or service and provision its DSN (client key) for SDK setup. Optionally links a connected repository with a root code mapping. Returns the project, its DSN, whether the repository linked, and the Sentry signals its platform supports, each with a docs link.", inputSchema: { organizationSlug: ParamOrganizationSlug, regionUrl: ParamRegionUrl.nullable().default(null), @@ -215,22 +247,34 @@ export default defineTool({ } } - const clientKey = await getOrCreateClientKey({ - apiService, - organizationSlug, - projectSlug: project.slug, - }); + const platform = params.platform ?? project.platform ?? null; + const [clientKey, organizationFeatures] = await Promise.all([ + getOrCreateClientKey({ + apiService, + organizationSlug, + projectSlug: project.slug, + }), + // Only needed to filter setup signals, so skip it without a platform. + platform + ? getOrganizationFeatures({ apiService, organizationSlug }) + : null, + ]); const dsn = clientKey?.dsn.public ?? null; - const guidance = [ - dsn - ? "Tell the user the project slug and DSN; the SDK needs the DSN." - : "The project exists, but its DSN could not be set up. Create one with create_dsn.", - ]; - if (repositoryMatch && !repositoryLinked) { - guidance.push( - "The repository did not link. Ask the user to check that the integration can access it, or link it in the project's Sentry settings.", - ); - } + const createDsnAction = dsn + ? null + : buildSuggestedToolAction({ + toolName: "create_dsn", + arguments: { + organizationSlug, + ...(params.regionUrl ? { regionUrl: params.regionUrl } : {}), + projectSlug: project.slug, + name: "Default", + }, + reason: "The project was created without a DSN.", + experimentalMode: context.experimentalMode ?? false, + availableToolNames: context.availableToolNames, + directToolNames: context.directToolNames, + }); return structuredResult({ project: { id: String(project.id), @@ -241,7 +285,8 @@ export default defineTool({ repository: repositoryMatch ? { name: repositoryMatch.name, linked: repositoryLinked } : null, - guidance: guidance.join(" "), + setup: buildProjectSetup(platform, organizationFeatures), + suggestedActions: createDsnAction ? [createDsnAction] : [], }); }, }); diff --git a/packages/mcp-core/src/tools/support/project-setup/platforms.json b/packages/mcp-core/src/tools/support/project-setup/platforms.json new file mode 100644 index 0000000000..43f4f2c92c --- /dev/null +++ b/packages/mcp-core/src/tools/support/project-setup/platforms.json @@ -0,0 +1,989 @@ +{ + "android": { + "name": "Android", + "docsUrl": "https://docs.sentry.io/platforms/android/", + "signals": { + "traces": "https://docs.sentry.io/platforms/android/tracing/", + "logs": "https://docs.sentry.io/platforms/android/logs/", + "metrics": "https://docs.sentry.io/platforms/android/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/android/session-replay/" + } + }, + "apple": { + "name": "Apple", + "docsUrl": "https://docs.sentry.io/platforms/apple/", + "signals": { + "traces": "https://docs.sentry.io/platforms/apple/tracing/", + "logs": "https://docs.sentry.io/platforms/apple/logs/", + "metrics": "https://docs.sentry.io/platforms/apple/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/apple/session-replay/" + } + }, + "apple-ios": { + "name": "iOS", + "docsUrl": "https://docs.sentry.io/platforms/apple/guides/ios/", + "signals": { + "traces": "https://docs.sentry.io/platforms/apple/guides/ios/tracing/", + "logs": "https://docs.sentry.io/platforms/apple/guides/ios/logs/", + "metrics": "https://docs.sentry.io/platforms/apple/guides/ios/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/apple/guides/ios/session-replay/" + } + }, + "apple-macos": { + "name": "macOS", + "docsUrl": "https://docs.sentry.io/platforms/apple/guides/macos/", + "signals": { + "traces": "https://docs.sentry.io/platforms/apple/guides/macos/tracing/", + "logs": "https://docs.sentry.io/platforms/apple/guides/macos/logs/", + "metrics": "https://docs.sentry.io/platforms/apple/guides/macos/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/apple/guides/macos/session-replay/" + } + }, + "bun": { + "name": "Bun", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/bun/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/bun/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/bun/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/bun/metrics/" + } + }, + "capacitor": { + "name": "Capacitor", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/capacitor/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/capacitor/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/capacitor/logs/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/capacitor/session-replay/" + } + }, + "cordova": { + "name": "Cordova", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/cordova/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/cordova/tracing/" + } + }, + "dart": { + "name": "Dart", + "docsUrl": "https://docs.sentry.io/platforms/dart/", + "signals": { + "traces": "https://docs.sentry.io/platforms/dart/tracing/", + "logs": "https://docs.sentry.io/platforms/dart/logs/", + "metrics": "https://docs.sentry.io/platforms/dart/metrics/" + } + }, + "deno": { + "name": "Deno", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/deno/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/deno/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/deno/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/deno/metrics/" + } + }, + "dotnet": { + "name": ".NET", + "docsUrl": "https://docs.sentry.io/platforms/dotnet/", + "signals": { + "traces": "https://docs.sentry.io/platforms/dotnet/tracing/", + "logs": "https://docs.sentry.io/platforms/dotnet/logs/", + "metrics": "https://docs.sentry.io/platforms/dotnet/metrics/" + } + }, + "dotnet-aspnet": { + "name": "ASP.NET", + "docsUrl": "https://docs.sentry.io/platforms/dotnet/guides/aspnet/", + "signals": { + "traces": "https://docs.sentry.io/platforms/dotnet/guides/aspnet/tracing/", + "logs": "https://docs.sentry.io/platforms/dotnet/guides/aspnet/logs/", + "metrics": "https://docs.sentry.io/platforms/dotnet/guides/aspnet/metrics/" + } + }, + "dotnet-aspnetcore": { + "name": "ASP.NET Core", + "docsUrl": "https://docs.sentry.io/platforms/dotnet/guides/aspnetcore/", + "signals": { + "traces": "https://docs.sentry.io/platforms/dotnet/guides/aspnetcore/tracing/", + "logs": "https://docs.sentry.io/platforms/dotnet/guides/aspnetcore/logs/", + "metrics": "https://docs.sentry.io/platforms/dotnet/guides/aspnetcore/metrics/" + } + }, + "dotnet-awslambda": { + "name": "AWS Lambda (.NET)", + "docsUrl": "https://docs.sentry.io/platforms/dotnet/guides/aws-lambda/", + "signals": { + "traces": "https://docs.sentry.io/platforms/dotnet/guides/aws-lambda/tracing/", + "logs": "https://docs.sentry.io/platforms/dotnet/guides/aws-lambda/logs/", + "metrics": "https://docs.sentry.io/platforms/dotnet/guides/aws-lambda/metrics/" + } + }, + "dotnet-gcpfunctions": { + "name": "Google Cloud Functions (.NET)", + "docsUrl": "https://docs.sentry.io/platforms/dotnet/guides/google-cloud-functions/", + "signals": { + "traces": "https://docs.sentry.io/platforms/dotnet/guides/google-cloud-functions/tracing/", + "metrics": "https://docs.sentry.io/platforms/dotnet/guides/google-cloud-functions/metrics/" + } + }, + "dotnet-maui": { + "name": ".NET MAUI", + "docsUrl": "https://docs.sentry.io/platforms/dotnet/guides/maui/", + "signals": { + "traces": "https://docs.sentry.io/platforms/dotnet/guides/maui/tracing/", + "logs": "https://docs.sentry.io/platforms/dotnet/guides/maui/logs/", + "metrics": "https://docs.sentry.io/platforms/dotnet/guides/maui/metrics/" + } + }, + "dotnet-winforms": { + "name": "Windows Forms", + "docsUrl": "https://docs.sentry.io/platforms/dotnet/guides/winforms/", + "signals": { + "traces": "https://docs.sentry.io/platforms/dotnet/guides/winforms/tracing/", + "logs": "https://docs.sentry.io/platforms/dotnet/guides/winforms/logs/", + "metrics": "https://docs.sentry.io/platforms/dotnet/guides/winforms/metrics/" + } + }, + "dotnet-wpf": { + "name": "WPF", + "docsUrl": "https://docs.sentry.io/platforms/dotnet/guides/wpf/", + "signals": { + "traces": "https://docs.sentry.io/platforms/dotnet/guides/wpf/tracing/", + "logs": "https://docs.sentry.io/platforms/dotnet/guides/wpf/logs/", + "metrics": "https://docs.sentry.io/platforms/dotnet/guides/wpf/metrics/" + } + }, + "dotnet-xamarin": { + "name": "Xamarin", + "docsUrl": "https://docs.sentry.io/platforms/dotnet/guides/xamarin/", + "signals": { + "traces": "https://docs.sentry.io/platforms/dotnet/guides/xamarin/tracing/" + } + }, + "electron": { + "name": "Electron", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/electron/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/electron/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/electron/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/electron/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/electron/session-replay/" + } + }, + "elixir": { + "name": "Elixir", + "docsUrl": "https://docs.sentry.io/platforms/elixir/", + "signals": { + "traces": "https://docs.sentry.io/platforms/elixir/tracing/", + "logs": "https://docs.sentry.io/platforms/elixir/logs/", + "metrics": "https://docs.sentry.io/platforms/elixir/metrics/" + } + }, + "expo": { + "name": "Expo", + "docsUrl": "https://docs.sentry.io/platforms/react-native/guides/expo/", + "signals": { + "traces": "https://docs.sentry.io/platforms/react-native/guides/expo/tracing/", + "logs": "https://docs.sentry.io/platforms/react-native/guides/expo/logs/", + "metrics": "https://docs.sentry.io/platforms/react-native/guides/expo/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/react-native/guides/expo/session-replay/" + } + }, + "flutter": { + "name": "Flutter", + "docsUrl": "https://docs.sentry.io/platforms/dart/guides/flutter/", + "signals": { + "traces": "https://docs.sentry.io/platforms/dart/guides/flutter/tracing/", + "logs": "https://docs.sentry.io/platforms/dart/guides/flutter/logs/", + "metrics": "https://docs.sentry.io/platforms/dart/guides/flutter/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/dart/guides/flutter/session-replay/" + } + }, + "go": { + "name": "Go", + "docsUrl": "https://docs.sentry.io/platforms/go/", + "signals": { + "traces": "https://docs.sentry.io/platforms/go/tracing/", + "logs": "https://docs.sentry.io/platforms/go/logs/", + "metrics": "https://docs.sentry.io/platforms/go/metrics/" + } + }, + "go-echo": { + "name": "Echo", + "docsUrl": "https://docs.sentry.io/platforms/go/guides/echo/", + "signals": { + "traces": "https://docs.sentry.io/platforms/go/guides/echo/tracing/", + "logs": "https://docs.sentry.io/platforms/go/guides/echo/logs/", + "metrics": "https://docs.sentry.io/platforms/go/guides/echo/metrics/" + } + }, + "go-fasthttp": { + "name": "FastHTTP", + "docsUrl": "https://docs.sentry.io/platforms/go/guides/fasthttp/", + "signals": { + "traces": "https://docs.sentry.io/platforms/go/guides/fasthttp/tracing/", + "logs": "https://docs.sentry.io/platforms/go/guides/fasthttp/logs/", + "metrics": "https://docs.sentry.io/platforms/go/guides/fasthttp/metrics/" + } + }, + "go-fiber": { + "name": "Fiber", + "docsUrl": "https://docs.sentry.io/platforms/go/guides/fiber/", + "signals": { + "traces": "https://docs.sentry.io/platforms/go/guides/fiber/tracing/", + "logs": "https://docs.sentry.io/platforms/go/guides/fiber/logs/", + "metrics": "https://docs.sentry.io/platforms/go/guides/fiber/metrics/" + } + }, + "go-gin": { + "name": "Gin", + "docsUrl": "https://docs.sentry.io/platforms/go/guides/gin/", + "signals": { + "traces": "https://docs.sentry.io/platforms/go/guides/gin/tracing/", + "logs": "https://docs.sentry.io/platforms/go/guides/gin/logs/", + "metrics": "https://docs.sentry.io/platforms/go/guides/gin/metrics/" + } + }, + "go-http": { + "name": "Net/Http", + "docsUrl": "https://docs.sentry.io/platforms/go/guides/http/", + "signals": { + "traces": "https://docs.sentry.io/platforms/go/guides/http/tracing/", + "logs": "https://docs.sentry.io/platforms/go/guides/http/logs/", + "metrics": "https://docs.sentry.io/platforms/go/guides/http/metrics/" + } + }, + "go-iris": { + "name": "Iris", + "docsUrl": "https://docs.sentry.io/platforms/go/guides/iris/", + "signals": { + "traces": "https://docs.sentry.io/platforms/go/guides/iris/tracing/", + "logs": "https://docs.sentry.io/platforms/go/guides/iris/logs/", + "metrics": "https://docs.sentry.io/platforms/go/guides/iris/metrics/" + } + }, + "go-negroni": { + "name": "Negroni", + "docsUrl": "https://docs.sentry.io/platforms/go/guides/negroni/", + "signals": { + "traces": "https://docs.sentry.io/platforms/go/guides/negroni/tracing/", + "logs": "https://docs.sentry.io/platforms/go/guides/negroni/logs/", + "metrics": "https://docs.sentry.io/platforms/go/guides/negroni/metrics/" + } + }, + "godot": { + "name": "Godot", + "docsUrl": "https://docs.sentry.io/platforms/godot/", + "signals": { + "traces": "https://docs.sentry.io/platforms/godot/tracing/", + "logs": "https://docs.sentry.io/platforms/godot/logs/", + "metrics": "https://docs.sentry.io/platforms/godot/metrics/" + } + }, + "ionic": { + "name": "Ionic", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/capacitor/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/capacitor/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/capacitor/logs/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/capacitor/session-replay/" + } + }, + "java": { + "name": "Java", + "docsUrl": "https://docs.sentry.io/platforms/java/", + "signals": { + "traces": "https://docs.sentry.io/platforms/java/tracing/", + "logs": "https://docs.sentry.io/platforms/java/logs/", + "metrics": "https://docs.sentry.io/platforms/java/metrics/" + } + }, + "java-log4j2": { + "name": "Log4j 2.x", + "docsUrl": "https://docs.sentry.io/platforms/java/guides/log4j2/", + "signals": { + "traces": "https://docs.sentry.io/platforms/java/guides/log4j2/tracing/", + "logs": "https://docs.sentry.io/platforms/java/guides/log4j2/logs/", + "metrics": "https://docs.sentry.io/platforms/java/guides/log4j2/metrics/" + } + }, + "java-logback": { + "name": "Logback", + "docsUrl": "https://docs.sentry.io/platforms/java/guides/logback/", + "signals": { + "traces": "https://docs.sentry.io/platforms/java/guides/logback/tracing/", + "logs": "https://docs.sentry.io/platforms/java/guides/logback/logs/", + "metrics": "https://docs.sentry.io/platforms/java/guides/logback/metrics/" + } + }, + "java-spring": { + "name": "Spring", + "docsUrl": "https://docs.sentry.io/platforms/java/guides/spring/", + "signals": { + "traces": "https://docs.sentry.io/platforms/java/guides/spring/tracing/", + "logs": "https://docs.sentry.io/platforms/java/guides/spring/logs/", + "metrics": "https://docs.sentry.io/platforms/java/guides/spring/metrics/" + } + }, + "java-spring-boot": { + "name": "Spring Boot", + "docsUrl": "https://docs.sentry.io/platforms/java/guides/spring-boot/", + "signals": { + "traces": "https://docs.sentry.io/platforms/java/guides/spring-boot/tracing/", + "logs": "https://docs.sentry.io/platforms/java/guides/spring-boot/logs/", + "metrics": "https://docs.sentry.io/platforms/java/guides/spring-boot/metrics/" + } + }, + "javascript": { + "name": "Browser JavaScript", + "docsUrl": "https://docs.sentry.io/platforms/javascript/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/session-replay/" + } + }, + "javascript-angular": { + "name": "Angular", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/angular/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/angular/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/angular/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/angular/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/angular/session-replay/" + } + }, + "javascript-astro": { + "name": "Astro", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/astro/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/astro/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/astro/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/astro/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/astro/session-replay/" + } + }, + "javascript-ember": { + "name": "Ember", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/ember/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/ember/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/ember/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/ember/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/ember/session-replay/" + } + }, + "javascript-gatsby": { + "name": "Gatsby", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/gatsby/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/gatsby/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/gatsby/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/gatsby/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/gatsby/session-replay/" + } + }, + "javascript-nextjs": { + "name": "Next.js", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/nextjs/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/nextjs/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/nextjs/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/nextjs/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/nextjs/session-replay/" + } + }, + "javascript-react": { + "name": "React", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/react/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/react/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/react/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/react/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/react/session-replay/" + } + }, + "javascript-react-router": { + "name": "React Router Framework", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/react-router/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/react-router/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/react-router/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/react-router/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/react-router/session-replay/" + } + }, + "javascript-remix": { + "name": "Remix", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/remix/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/remix/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/remix/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/remix/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/remix/session-replay/" + } + }, + "javascript-solid": { + "name": "Solid", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/solid/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/solid/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/solid/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/solid/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/solid/session-replay/" + } + }, + "javascript-solidstart": { + "name": "SolidStart", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/solidstart/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/solidstart/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/solidstart/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/solidstart/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/solidstart/session-replay/" + } + }, + "javascript-svelte": { + "name": "Svelte", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/svelte/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/svelte/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/svelte/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/svelte/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/svelte/session-replay/" + } + }, + "javascript-sveltekit": { + "name": "SvelteKit", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/sveltekit/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/sveltekit/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/sveltekit/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/sveltekit/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/sveltekit/session-replay/" + } + }, + "javascript-tanstackstart-react": { + "name": "TanStack Start React", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/tanstackstart-react/session-replay/" + } + }, + "javascript-vue": { + "name": "Vue", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/vue/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/vue/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/vue/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/vue/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/vue/session-replay/" + } + }, + "javascript-nuxt": { + "name": "Nuxt", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/nuxt/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/nuxt/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/nuxt/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/nuxt/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/javascript/guides/nuxt/session-replay/" + } + }, + "kotlin": { + "name": "Kotlin", + "docsUrl": "https://docs.sentry.io/platforms/kotlin/", + "signals": {} + }, + "minidump": { + "name": "Minidump", + "docsUrl": "https://docs.sentry.io/platforms/native/guides/minidumps/", + "signals": { + "traces": "https://docs.sentry.io/platforms/native/guides/minidumps/tracing/" + } + }, + "native": { + "name": "Native", + "docsUrl": "https://docs.sentry.io/platforms/native/", + "signals": { + "traces": "https://docs.sentry.io/platforms/native/tracing/", + "logs": "https://docs.sentry.io/platforms/native/logs/", + "metrics": "https://docs.sentry.io/platforms/native/metrics/" + } + }, + "native-qt": { + "name": "Qt", + "docsUrl": "https://docs.sentry.io/platforms/native/guides/qt/", + "signals": { + "traces": "https://docs.sentry.io/platforms/native/guides/qt/tracing/" + } + }, + "nintendo-switch": { + "name": "Nintendo Switch", + "docsUrl": "https://docs.sentry.io/platforms/nintendo-switch/", + "signals": {} + }, + "node": { + "name": "Node.js", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/node/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/node/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/node/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/node/metrics/" + } + }, + "node-awslambda": { + "name": "AWS Lambda (Node)", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/aws-lambda/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/aws-lambda/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/aws-lambda/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/aws-lambda/metrics/" + } + }, + "node-azurefunctions": { + "name": "Azure Functions (Node)", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/azure-functions/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/azure-functions/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/azure-functions/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/azure-functions/metrics/" + } + }, + "node-cloudflare-pages": { + "name": "Cloudflare (Node)", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/cloudflare/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/cloudflare/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/cloudflare/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/cloudflare/metrics/" + } + }, + "node-cloudflare-workers": { + "name": "Cloudflare (Node)", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/cloudflare/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/cloudflare/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/cloudflare/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/cloudflare/metrics/" + } + }, + "node-connect": { + "name": "Connect", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/node/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/node/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/node/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/node/metrics/" + } + }, + "node-eve": { + "name": "Eve", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/eve/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/eve/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/eve/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/eve/metrics/" + } + }, + "node-express": { + "name": "Express", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/express/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/node/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/node/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/node/metrics/" + } + }, + "node-fastify": { + "name": "Fastify", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/fastify/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/node/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/node/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/node/metrics/" + } + }, + "node-flue": { + "name": "Flue", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/flue/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/flue/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/flue/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/flue/metrics/" + } + }, + "node-hapi": { + "name": "Hapi", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/hapi/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/node/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/node/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/node/metrics/" + } + }, + "node-hono": { + "name": "Hono", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/hono/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/hono/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/hono/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/hono/metrics/" + } + }, + "node-gcpfunctions": { + "name": "Google Cloud Functions (Node)", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/gcp-functions/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/gcp-functions/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/gcp-functions/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/gcp-functions/metrics/" + } + }, + "node-koa": { + "name": "Koa", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/koa/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/node/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/node/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/node/metrics/" + } + }, + "node-mastra": { + "name": "Mastra", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/mastra/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/mastra/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/mastra/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/mastra/metrics/" + } + }, + "node-nestjs": { + "name": "Nest.js", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/nestjs/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/nestjs/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/nestjs/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/nestjs/metrics/" + } + }, + "node-pi-durable": { + "name": "Pi Durable", + "docsUrl": "https://docs.sentry.io/platforms/javascript/guides/pi-durable/", + "signals": { + "traces": "https://docs.sentry.io/platforms/javascript/guides/pi-durable/tracing/", + "logs": "https://docs.sentry.io/platforms/javascript/guides/pi-durable/logs/", + "metrics": "https://docs.sentry.io/platforms/javascript/guides/pi-durable/metrics/" + } + }, + "php": { + "name": "PHP", + "docsUrl": "https://docs.sentry.io/platforms/php/", + "signals": { + "traces": "https://docs.sentry.io/platforms/php/tracing/", + "logs": "https://docs.sentry.io/platforms/php/logs/", + "metrics": "https://docs.sentry.io/platforms/php/metrics/" + } + }, + "php-laravel": { + "name": "Laravel", + "docsUrl": "https://docs.sentry.io/platforms/php/guides/laravel/", + "signals": { + "traces": "https://docs.sentry.io/platforms/php/guides/laravel/tracing/", + "logs": "https://docs.sentry.io/platforms/php/guides/laravel/logs/", + "metrics": "https://docs.sentry.io/platforms/php/guides/laravel/metrics/" + } + }, + "php-symfony": { + "name": "Symfony", + "docsUrl": "https://docs.sentry.io/platforms/php/guides/symfony/", + "signals": { + "traces": "https://docs.sentry.io/platforms/php/guides/symfony/tracing/", + "logs": "https://docs.sentry.io/platforms/php/guides/symfony/logs/", + "metrics": "https://docs.sentry.io/platforms/php/guides/symfony/metrics/" + } + }, + "playstation": { + "name": "PlayStation", + "docsUrl": "https://docs.sentry.io/platforms/playstation/", + "signals": {} + }, + "powershell": { + "name": "PowerShell", + "docsUrl": "https://docs.sentry.io/platforms/powershell/", + "signals": { + "traces": "https://docs.sentry.io/platforms/powershell/tracing/" + } + }, + "python": { + "name": "Python", + "docsUrl": "https://docs.sentry.io/platforms/python/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-aiohttp": { + "name": "AIOHTTP", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/aiohttp/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-asgi": { + "name": "ASGI", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/asgi/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-awslambda": { + "name": "AWS Lambda (Python)", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/aws-lambda/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-bottle": { + "name": "Bottle", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/bottle/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-celery": { + "name": "Celery", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/celery/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-chalice": { + "name": "Chalice", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/chalice/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-django": { + "name": "Django", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/django/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-falcon": { + "name": "Falcon", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/falcon/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-fastapi": { + "name": "FastAPI", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/fastapi/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-flask": { + "name": "Flask", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/flask/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-litestar": { + "name": "Litestar", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/litestar/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-gcpfunctions": { + "name": "Google Cloud Functions (Python)", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/gcp-functions/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-pyramid": { + "name": "Pyramid", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/pyramid/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-quart": { + "name": "Quart", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/quart/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-rq": { + "name": "RQ (Redis Queue)", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/rq/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-sanic": { + "name": "Sanic", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/sanic/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-serverless": { + "name": "Serverless (Python)", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/serverless/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-starlette": { + "name": "Starlette", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/starlette/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-tornado": { + "name": "Tornado", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/tornado/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-tryton": { + "name": "Tryton", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/tryton/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "python-wsgi": { + "name": "WSGI", + "docsUrl": "https://docs.sentry.io/platforms/python/integrations/wsgi/", + "signals": { + "traces": "https://docs.sentry.io/platforms/python/tracing/", + "logs": "https://docs.sentry.io/platforms/python/logs/", + "metrics": "https://docs.sentry.io/platforms/python/metrics/" + } + }, + "react-native": { + "name": "React Native", + "docsUrl": "https://docs.sentry.io/platforms/react-native/", + "signals": { + "traces": "https://docs.sentry.io/platforms/react-native/tracing/", + "logs": "https://docs.sentry.io/platforms/react-native/logs/", + "metrics": "https://docs.sentry.io/platforms/react-native/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/react-native/session-replay/" + } + }, + "ruby": { + "name": "Ruby", + "docsUrl": "https://docs.sentry.io/platforms/ruby/", + "signals": { + "traces": "https://docs.sentry.io/platforms/ruby/tracing/", + "logs": "https://docs.sentry.io/platforms/ruby/logs/", + "metrics": "https://docs.sentry.io/platforms/ruby/metrics/" + } + }, + "ruby-rack": { + "name": "Rack Middleware", + "docsUrl": "https://docs.sentry.io/platforms/ruby/guides/rack/", + "signals": { + "traces": "https://docs.sentry.io/platforms/ruby/guides/rack/tracing/", + "metrics": "https://docs.sentry.io/platforms/ruby/guides/rack/metrics/" + } + }, + "ruby-rails": { + "name": "Rails", + "docsUrl": "https://docs.sentry.io/platforms/ruby/guides/rails/", + "signals": { + "traces": "https://docs.sentry.io/platforms/ruby/guides/rails/tracing/", + "logs": "https://docs.sentry.io/platforms/ruby/guides/rails/logs/", + "metrics": "https://docs.sentry.io/platforms/ruby/guides/rails/metrics/" + } + }, + "rust": { + "name": "Rust", + "docsUrl": "https://docs.sentry.io/platforms/rust/", + "signals": { + "traces": "https://docs.sentry.io/platforms/rust/tracing/", + "logs": "https://docs.sentry.io/platforms/rust/logs/", + "metrics": "https://docs.sentry.io/platforms/rust/metrics/" + } + }, + "unity": { + "name": "Unity", + "docsUrl": "https://docs.sentry.io/platforms/unity/", + "signals": { + "traces": "https://docs.sentry.io/platforms/unity/tracing/", + "logs": "https://docs.sentry.io/platforms/unity/logs/", + "metrics": "https://docs.sentry.io/platforms/unity/metrics/" + } + }, + "unreal": { + "name": "Unreal Engine", + "docsUrl": "https://docs.sentry.io/platforms/unreal/", + "signals": { + "traces": "https://docs.sentry.io/platforms/unreal/tracing/", + "logs": "https://docs.sentry.io/platforms/unreal/logs/", + "metrics": "https://docs.sentry.io/platforms/unreal/metrics/", + "sessionReplay": "https://docs.sentry.io/platforms/unreal/session-replay/" + } + }, + "xbox": { + "name": "Xbox", + "docsUrl": "https://docs.sentry.io/platforms/xbox/", + "signals": {} + } +} diff --git a/packages/mcp-core/src/tools/support/project-setup/project-setup.ts b/packages/mcp-core/src/tools/support/project-setup/project-setup.ts new file mode 100644 index 0000000000..c8223b662d --- /dev/null +++ b/packages/mcp-core/src/tools/support/project-setup/project-setup.ts @@ -0,0 +1,144 @@ +import { z } from "zod"; +import platforms from "./platforms.json" with { type: "json" }; + +export const projectSetupSchema = z + .object({ + platform: z.string().describe("Platform display name, such as `Next.js`."), + docsUrl: z.string().describe("Sentry setup guide for the platform."), + signals: z + .array( + z.object({ + name: z.string(), + usefulFor: z.string(), + recommended: z + .literal(true) + .optional() + .describe("Set on signals the SDK's default setup turns on."), + docsUrl: z.string(), + }), + ) + .describe( + "Core signals the platform supports and the organization has enabled.", + ), + }) + .nullable() + .describe("Setup knowledge for the project's platform, or null without one."); + +type ProjectSetup = z.output; + +type PlatformSignalKey = "traces" | "logs" | "metrics" | "sessionReplay"; + +interface PlatformSetupEntry { + name: string; + docsUrl: string; + signals: Partial>; +} + +const PLATFORM_SETUP: Readonly> = platforms; + +interface SignalDefinition { + name: string; + usefulFor: string; + recommended: boolean; + /** Organization feature that must be on, as Sentry's onboarding checks it. */ + feature?: string; +} + +// Order is the order the result lists signals in. Errors has no key: every +// platform supports it, and its docs are the platform setup guide. +const SIGNALS: ReadonlyArray<[PlatformSignalKey | "errors", SignalDefinition]> = + [ + [ + "errors", + { + name: "Errors", + usefulFor: + "Unhandled exceptions and crashes, grouped into issues with stack traces and the state that led to them", + recommended: true, + }, + ], + [ + "traces", + { + name: "Traces", + usefulFor: + "Debugging how requests, background jobs, and AI agent runs flow across services, and where they fail or slow down", + recommended: true, + }, + ], + [ + "logs", + { + name: "Logs", + usefulFor: + "Structured app logs linked to the trace and error they came from, for context a stack trace lacks", + recommended: false, + feature: "ourlogs-enabled", + }, + ], + [ + "metrics", + { + name: "Metrics", + usefulFor: + "Counters, gauges, and distributions to chart and alert on, such as signups, queue depth, or token usage", + recommended: false, + feature: "tracemetrics-enabled", + }, + ], + [ + "sessionReplay", + { + name: "Session Replay", + usefulFor: + "Understanding how users behave in a web or mobile UI: clicks, navigation, network calls, and errors in a replay, to reproduce bugs and find friction", + recommended: false, + feature: "session-replay", + }, + ], + ]; + +/** + * Builds setup knowledge for a Sentry platform ID: its setup guide and the + * core signals its SDK supports, each with a docs link. + * + * `organizationFeatures` drops signals the organization has not enabled. Pass + * null when the features are unknown, and every supported signal is listed. + * Returns null for a missing or unknown platform. + */ +export function buildProjectSetup( + platform: string | null | undefined, + organizationFeatures: readonly string[] | null, +): ProjectSetup { + const entry = platform ? PLATFORM_SETUP[platform] : undefined; + if (!entry) { + return null; + } + + const signals: NonNullable["signals"] = []; + for (const [key, definition] of SIGNALS) { + const signalDocsUrl = key === "errors" ? entry.docsUrl : entry.signals[key]; + if (!signalDocsUrl) { + continue; + } + if ( + definition.feature && + organizationFeatures && + !organizationFeatures.includes(definition.feature) + ) { + continue; + } + signals.push({ + name: definition.name, + usefulFor: definition.usefulFor, + ...(definition.recommended ? { recommended: true as const } : {}), + docsUrl: signalDocsUrl, + }); + } + + return { + platform: entry.name, + docsUrl: entry.docsUrl, + signals, + }; +}