Add an MCP server for the API, deployable next to the application
mcp/ exposes both APIs as MCP tools, one per operation in openapi.yaml, named after the Laravel route each lands on (public_projects_index, admin_pages_update, ...). Nothing is written by hand: the tools are derived from the document the target application serves, which the contract tests already hold to the truth. Two transports over one core: - stdio (`node mcp/server.mjs`), registered in .mcp.json, signing in with credentials from the environment and refreshing the token. - Streamable HTTP (`--http`), stateless, deployed as the landing-mcp service. It holds no credentials: each request brings its caller's Pireon Basic credentials or bearer token, so the API applies that person's permissions. Sessions live in memory keyed by a hash, refused credentials are remembered for a minute, and the spec is reloaded every minute so new endpoints appear without a redeploy. Left out on purpose: the token exchange, telemetry, and the contact and apply forms, which notify real people. The preview secret is never sent for anonymous callers, and is unset in the deployment by default. A CI job runs the Node tests, including the HTTP mode end to end against a fake application. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
78
mcp/src/catalogue.mjs
Normal file
78
mcp/src/catalogue.mjs
Normal file
@@ -0,0 +1,78 @@
|
||||
/**
|
||||
* The OpenAPI document and the tools derived from it.
|
||||
*
|
||||
* Loaded from the application the server talks to, and — for a long-running
|
||||
* deployment — reloaded now and then, so that deploying a new endpoint to the
|
||||
* application makes it a tool here without also redeploying this.
|
||||
*/
|
||||
|
||||
import { readFile } from 'node:fs/promises';
|
||||
import { parse } from 'yaml';
|
||||
import { buildTools } from './tools.mjs';
|
||||
|
||||
export class Catalogue {
|
||||
/**
|
||||
* @param {object} options
|
||||
* @param {string} options.source Path or URL of openapi.yaml.
|
||||
* @param {string} options.baseUrl Application root the document's server URL is relative to.
|
||||
* @param {number} [options.ttlMs] How long a loaded document is trusted. Infinity: load once.
|
||||
*/
|
||||
constructor({ source, baseUrl, ttlMs = Infinity }) {
|
||||
this.source = source;
|
||||
this.baseUrl = baseUrl.replace(/\/+$/, '');
|
||||
this.ttlMs = ttlMs;
|
||||
this.current = null;
|
||||
this.loadedAt = 0;
|
||||
this.pending = null;
|
||||
}
|
||||
|
||||
/** @returns {Promise<{spec: object, tools: import('./tools.mjs').Tool[], apiBase: string}>} */
|
||||
async get() {
|
||||
if (this.current && Date.now() - this.loadedAt < this.ttlMs) return this.current;
|
||||
|
||||
this.pending ??= this.load().finally(() => { this.pending = null; });
|
||||
|
||||
try {
|
||||
return await this.pending;
|
||||
} catch (error) {
|
||||
// An application that is redeploying, or briefly down, should not take
|
||||
// the tools with it: the last document that loaded is still the best
|
||||
// description available. Only the very first load has nothing to fall
|
||||
// back on.
|
||||
if (this.current) {
|
||||
console.error(`landing-mcp: keeping the previous OpenAPI document: ${error.message}`);
|
||||
this.loadedAt = Date.now();
|
||||
|
||||
return this.current;
|
||||
}
|
||||
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
async load() {
|
||||
const spec = parse(await this.read());
|
||||
|
||||
// The document's own server URL ("/api"), relative to the application root.
|
||||
const serverUrl = spec.servers?.[0]?.url ?? '/api';
|
||||
|
||||
this.current = {
|
||||
spec,
|
||||
tools: buildTools(spec),
|
||||
apiBase: /^https?:\/\//.test(serverUrl) ? serverUrl : `${this.baseUrl}${serverUrl}`,
|
||||
};
|
||||
this.loadedAt = Date.now();
|
||||
|
||||
return this.current;
|
||||
}
|
||||
|
||||
async read() {
|
||||
if (!/^https?:\/\//.test(this.source)) return readFile(this.source, 'utf8');
|
||||
|
||||
const response = await fetch(this.source, { signal: AbortSignal.timeout(15_000) });
|
||||
|
||||
if (!response.ok) throw new Error(`GET ${this.source} answered ${response.status}`);
|
||||
|
||||
return response.text();
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user