Skip to content

armgit / dub

Public Imported from GitHub
0

The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.

2.5 KB
Raw Blame
import { document } from ".";
import { OAUTH_SCOPE_DESCRIPTIONS, OAUTH_SCOPES } from "../api/oauth/constants";

// OpenAPI document served at `api.dub.co/?mcp` for MCP clients.
// Copies the public spec, adds an OAuth 2.0 (authorization code) security scheme
// with the scopes from OAUTH_SCOPES, and accepts either the API key (`token`) or
// OAuth at the document level. Token-only operation security is removed so those
// operations inherit that rule. Operations with no security stay public.
//
// Example (truncated):
// {
//   "openapi": "3.0.3",
//   "paths": { ... },
//   "components": {
//     "securitySchemes": {
//       "token": { "type": "http", "scheme": "bearer", ... },
//       "oauth": {
//         "type": "oauth2",
//         "flows": {
//           "authorizationCode": {
//             "authorizationUrl": "https://app.dub.co/oauth/authorize",
//             "tokenUrl": "https://api.dub.co/oauth/token",
//             "scopes": { "links.read": "Read access to links", ... }
//           }
//         }
//       }
//     }
//   },
//   "security": [{ "token": [] }, { "oauth": [] }]
// }
export function getMcpDocument(): typeof document {
  const mcpDocument = structuredClone(document);

  mcpDocument.components = {
    ...mcpDocument.components,
    securitySchemes: {
      ...mcpDocument.components?.securitySchemes,
      oauth: {
        type: "oauth2",
        description: "OAuth 2.0 authentication",
        flows: {
          authorizationCode: {
            authorizationUrl: "https://app.dub.co/oauth/authorize",
            tokenUrl: "https://api.dub.co/oauth/token",
            scopes: Object.fromEntries(
              OAUTH_SCOPES.map((scope) => [
                scope,
                OAUTH_SCOPE_DESCRIPTIONS[
                  scope as keyof typeof OAUTH_SCOPE_DESCRIPTIONS
                ] ?? scope,
              ]),
            ),
          },
        },
      },
    },
  };

  mcpDocument.security = [{ token: [] }, { oauth: [] }];

  for (const pathItem of Object.values(mcpDocument.paths ?? {})) {
    for (const method of [
      "get",
      "put",
      "post",
      "delete",
      "options",
      "head",
      "patch",
      "trace",
    ] as const) {
      const operation = pathItem?.[method];
      if (!operation) continue;

      if (operation.security === undefined) {
        operation.security = [];
        continue;
      }

      if (
        JSON.stringify(operation.security) === JSON.stringify([{ token: [] }])
      ) {
        delete operation.security;
      }
    }
  }

  return mcpDocument;
}