Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 159x 159x 1x 1x 1x 1x 1x 1x 1x 1x 177x 177x 1x 1x 177x 130x 129x 129x 130x 177x 17x 17x 177x 177x 1x 1x 1x 1x 1x 1x 111x 111x 1x 1x 111x 111x 53x 111x 41x 111x 14x 111x 2x 111x 111x 1x 1x 1x 1x 1x 1x 1x 1x 1x 148x 148x 148x 148x 148x 148x 148x 110x 111x 111x 3x 3x 111x 111x 110x 148x 148x 148x 148x 148x 81x 148x 148x 148x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 17x 17x 17x 17x 151x 151x 151x 151x 17x 17x 1x 1x 1x 1x 1x 1x 1x 1x 147x 147x 147x 147x 147x 147x 147x 142x 142x 147x 5x 5x 147x 147x 1x 1x 147x 4x 4x 2x 2x 147x 147x 147x 1x 1x 1x 1x 1x 1x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 143x 1x 1x 1x 1x 1x 1x 1x 1x 1x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 17x 147x 147x 143x 143x 143x 147x 17x 3x 3x 3x 3x 3x 3x 3x 3x 3x 17x 1x 1x 1x 1x 1x 17x 13x 13x 13x 123x 123x 123x 123x 123x 123x 123x 123x 13x 13x 17x | "use strict";
/**
* Merge SDK analysis with OpenAPI operations into method records.
*
* Bindings are matched on HTTP method plus path template. Methods that
* match no operation, or more than one, are reported as errors rather than
* guessed.
*
* @module prepare/method-records
*/
import { OagMcpError } from "../errors.js";
import { trimTrailingSlashes } from "../util/path.js";
import type {
AuthSummary,
MethodRecord,
OperationBinding,
SecurityRequirement,
SecuritySchemeInfo,
SpecOperation,
SpecSummary,
} from "../types.js";
import {
type AnalyzedMethod,
type ExampleHints,
normaliseName,
} from "./analyze.js";
/**
* Normalise a path template so parameter names do not matter.
*
* @param {String} p - path template
* @return {String} normalised template
*/
export function normalisePathTemplate(p: string): string {
return trimTrailingSlashes(p.replace(/\{[^{}]+\}/g, "{}")) || "/";
}
/**
* Build example hints for an operation from its OpenAPI parameters and body.
*
* @param {Object} op - spec operation
* @return {Object} hints keyed by normalised name
*/
export function hintsForOperation(op: SpecOperation | undefined): ExampleHints {
const hints: ExampleHints = {};
if (!op) {
return hints;
}
for (const p of op.parameters) {
if (p.example !== undefined) {
hints[normaliseName(p.name)] = p.example;
}
}
if (op.requestBody?.example !== undefined) {
hints.__body = op.requestBody.example;
}
return hints;
}
/**
* How a scheme is shown to agents, e.g. "http-bearer" or "apiKey-header".
*
* @private
*/
function _schemeType(s: SecuritySchemeInfo | undefined): string {
if (!s) {
return "undefined-scheme";
}
switch (s.type) {
case "http":
return `http-${s.scheme}`;
case "apiKey":
return `apiKey-${s.in}`;
case "oauth2":
return "oauth2-client-credentials";
default:
return s.type;
}
}
/**
* Summarise authentication requirements for agents.
*
* @param {Array} security - effective requirement alternatives
* @param {Object} schemes - security schemes
* @return {Object} auth summary
*/
export function summariseAuth(
security: SecurityRequirement[],
schemes: Record<string, SecuritySchemeInfo>,
): AuthSummary {
const unsupported = new Set<string>();
const alternatives = security
.filter((req) => Object.keys(req).length > 0)
.map((req) => ({
schemes: Object.entries(req).map(([name, scopes]) => {
const s = schemes[name];
if (!s || !s.supported) {
unsupported.add(name);
}
const type = _schemeType(s);
return { name, type, scopes };
}),
}));
return {
alternatives,
optional:
security.length === 0 ||
security.some((r) => Object.keys(r).length === 0),
unsupportedSchemes: [...unsupported].sort(),
};
}
/** Spec operations by key, and by method and normalised path. */
interface OperationIndex {
byKey: Map<string, SpecOperation>;
byNormalised: Map<string, SpecOperation[]>;
}
/**
* Index the spec's operations for matching.
*
* @private
*/
function _operationIndex(spec: SpecSummary): OperationIndex {
const byKey = new Map<string, SpecOperation>();
const byNormalised = new Map<string, SpecOperation[]>();
for (const op of spec.operations) {
byKey.set(op.key, op);
const nk = `${op.method} ${normalisePathTemplate(op.path)}`;
byNormalised.set(nk, [...(byNormalised.get(nk) ?? []), op]);
}
return { byKey, byNormalised };
}
/**
* The operation an SDK method calls: the one with its exact method and
* path, or the only one matching once path parameter names are ignored.
* Otherwise the problem is recorded and undefined returned.
*
* @private
*/
function _matchOperation(
m: AnalyzedMethod,
index: OperationIndex,
problems: string[],
): SpecOperation | undefined {
const exact = index.byKey.get(`${m.httpMethod} ${m.path}`);
if (exact) {
return exact;
}
const candidates =
index.byNormalised.get(
`${m.httpMethod} ${normalisePathTemplate(m.path)}`,
) ?? [];
if (candidates.length === 1) {
return candidates[0];
}
const method = `${m.className}.${m.methodName} (${m.httpMethod} ${m.path})`;
problems.push(
candidates.length > 1
? `${method} matches several operations: ${candidates.map((c) => c.key).join(", ")}`
: `${method} has no matching operation in the spec`,
);
return undefined;
}
/**
* The method record of an SDK method bound to its operation.
*
* @private
*/
function _record(
m: AnalyzedMethod,
op: SpecOperation,
spec: SpecSummary,
): MethodRecord {
const id = `${m.className}.${m.methodName}`;
return {
id,
className: m.className,
methodName: m.methodName,
sdkPath: `sdk.${id}`,
operationId: op.operationId,
httpMethod: op.method,
path: op.path,
tags: op.tags,
summary: op.summary,
description: op.description ?? (m.documentation || undefined),
deprecated: op.deprecated || m.deprecated,
signature: m.signature,
parameters: m.parameters,
inputType: m.inputType,
returnType: m.returnType,
referencedTypes: m.referencedTypes,
requiredArguments: m.requiredArguments,
apiParameters: op.parameters,
requestBody: op.requestBody,
responses: op.responses,
auth: summariseAuth(op.security, spec.securitySchemes),
security: op.security,
example: m.example,
};
}
/**
* Build method records and operation bindings.
*
* @param {Object} spec - spec summary
* @param {Array} methods - analysed SDK methods
* @return {Object} { records, bindings, unmapped }
*/
export function buildRecords(
spec: SpecSummary,
methods: AnalyzedMethod[],
): {
records: MethodRecord[];
bindings: OperationBinding[];
unmapped: Array<{ key: string; operationId?: string }>;
} {
const index = _operationIndex(spec);
const problems: string[] = [];
const records: MethodRecord[] = [];
const bound = new Set<string>();
for (const m of methods) {
const op = _matchOperation(m, index, problems);
if (op) {
bound.add(op.key);
records.push(_record(m, op, spec));
}
}
if (problems.length > 0) {
throw new OagMcpError(
"SDK_SPEC_MISMATCH",
`The SDK does not match the OpenAPI document: ${problems.slice(0, 5).join("; ")}`,
{
hint: "Make sure --spec is the document the SDK was generated from (or regenerate the SDK from this document), then restart oag-mcp.",
details: { problems },
},
);
}
if (records.length === 0) {
throw new OagMcpError(
"SDK_NO_METHODS",
"No SDK methods could be bound to OpenAPI operations",
);
}
const unmapped = spec.operations
.filter((op) => !bound.has(op.key))
.map((op) => ({ key: op.key, operationId: op.operationId }));
const bindings: OperationBinding[] = records.map((r) => ({
id: r.id,
className: r.className,
methodName: r.methodName,
httpMethod: r.httpMethod,
path: r.path,
operationId: r.operationId,
tags: r.tags,
security: r.security,
}));
return { records, bindings, unmapped };
}
|