Skip to main content
Glama

Sentry MCP

Official
by getsentry
coding-guidelines.mdc2.75 kB
# Coding Guidelines Essential patterns and standards for Sentry MCP development. ## TypeScript Configuration ```typescript // tsconfig.json essentials { "compilerOptions": { "strict": true, "target": "ES2022", "module": "ESNext", "moduleResolution": "Bundler", "sourceMap": true, "noImplicitAny": true } } ``` ## Code Style ### Biome Configuration - 2 spaces, double quotes, semicolons - Max line: 100 chars - Trailing commas in multiline ### Naming Conventions - Files: `kebab-case.ts` - Functions: `camelCase` - Types/Classes: `PascalCase` - Constants: `UPPER_SNAKE_CASE` ### Import Order ```typescript // 1. Node built-ins import { readFile } from "node:fs/promises"; // 2. External deps import { z } from "zod"; // 3. Internal packages import { mockData } from "@sentry-mcp/mocks"; // 4. Relative imports import { UserInputError } from "./errors.js"; ``` ## Tool Implementation ```typescript export const toolName = { description: "Clear, concise description", parameters: z.object({ required: z.string().describe("Description"), optional: z.string().optional() }), execute: async (params, context) => { // 1. Validate inputs // 2. Call API // 3. Format output return formatResponse(data); } }; ``` ## Testing Standards ```typescript describe("Component", () => { it("handles normal case", async () => { // Arrange const input = createTestInput(); // Act const result = await method(input); // Assert expect(result).toMatchInlineSnapshot(); }); }); ``` Key practices: - Use inline snapshots for formatting - Mock with MSW - Test success and error paths - Keep tests isolated ## Quality Checklist Before committing: ```bash pnpm -w run lint # Biome check pnpm -w run lint:fix # Fix issues pnpm tsc --noEmit # Type check pnpm test # Run tests pnpm -w run build # Build all ``` ## JSDoc Pattern ```typescript /** * Brief description. * * @param param - Description * @returns What it returns * * @example * ```typescript * const result = func(param); * ``` */ ``` ## Security Essentials - Never commit secrets - Validate all inputs - Use environment variables - Sanitize displayed data ## Common Patterns For shared patterns see: - Error handling: `common-patterns.mdc#error-handling` - Zod schemas: `common-patterns.mdc#zod-schema-patterns` - API usage: `api-patterns.mdc` - Testing: `testing.mdc` ## Monorepo Commands ```bash # Workspace-wide (from root) pnpm -w run lint # Package-specific (from package dir) pnpm test ``` ## References - Architecture: `architecture.mdc` - Testing guide: `testing.mdc` - API patterns: `api-patterns.mdc` - Common patterns: `common-patterns.mdc`

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/getsentry/sentry-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server