@borgresearch/odin-mcp 0.1.0 → 0.3.0

package/dist/guidance.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Guidance the Odin MCP server gives to AI agents: the short server
+ * instructions sent when a client connects, and the longer prompts a user can
+ * run (or paste) to set up Odin and fix a finding. Kept free of Node APIs so
+ * the Odin web app can build the same text for its copy-to-agent prompt.
+ */
+declare const ODIN_DOCS_URL = "https://docs.borghq.io";
+declare const ODIN_DOCS_INDEX_URL = "https://docs.borghq.io/llms.txt";
+declare const ODIN_AGENT_GUIDE_URL = "https://docs.borghq.io/platform/agent-guide.md";
+/**
+ * What the user may do in Odin. `read` is the Read only role, `member` is
+ * Member, and `admin` covers Admin and Owner. Leave it unset when unknown.
+ */
+type OdinAccess = "read" | "member" | "admin";
+interface GuidanceOptions {
+    /** Public Odin origin used for links, e.g. https://odin.borghq.io. */
+    appUrl?: string;
+}
+/** Odin pages the setup guidance can send the user to. */
+type OdinSetupPage = "integrations" | "prReviews" | "assets" | "team";
+interface SetupPromptOptions extends GuidanceOptions {
+    access?: OdinAccess;
+    /**
+     * Pages switched on for the organisation. A page set to false is left out
+     * of the recommendations; an unknown page is assumed to be available.
+     */
+    pages?: Partial<Record<OdinSetupPage, boolean>>;
+    /**
+     * Markdown that tells the agent how to add the Odin MCP server. When set,
+     * the prompt starts with a connection step; when unset, the prompt assumes
+     * the Odin tools are already available (as when it runs as an MCP prompt).
+     */
+    connectInstructions?: string;
+}
+interface FixFindingPromptOptions extends GuidanceOptions {
+    /** Human identifier such as ODI-12. Unset means pick the most severe. */
+    finding?: string;
+}
+/**
+ * Short, always-loaded orientation for any agent that connects. Clients add
+ * this to every session's context, so it stays brief and leaves the
+ * step-by-step flows to the prompts.
+ */
+declare function buildServerInstructions(options?: GuidanceOptions): string;
+/**
+ * The setup walkthrough: connect, learn, inspect, recommend, reach a first
+ * result and remember Odin in the repository.
+ */
+declare function buildSetupPrompt(options?: SetupPromptOptions): string;
+/** One finding, from choice to a linked pull request awaiting retest. */
+declare function buildFixFindingPrompt(options?: FixFindingPromptOptions): string;
+
+export { type FixFindingPromptOptions, type GuidanceOptions, ODIN_AGENT_GUIDE_URL, ODIN_DOCS_INDEX_URL, ODIN_DOCS_URL, type OdinAccess, type OdinSetupPage, type SetupPromptOptions, buildFixFindingPrompt, buildServerInstructions, buildSetupPrompt };

package/dist/guidance.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+import {
+  ODIN_AGENT_GUIDE_URL,
+  ODIN_DOCS_INDEX_URL,
+  ODIN_DOCS_URL,
+  buildFixFindingPrompt,
+  buildServerInstructions,
+  buildSetupPrompt
+} from "./chunk-4LCKW236.js";
+export {
+  ODIN_AGENT_GUIDE_URL,
+  ODIN_DOCS_INDEX_URL,
+  ODIN_DOCS_URL,
+  buildFixFindingPrompt,
+  buildServerInstructions,
+  buildSetupPrompt
+};
+//# sourceMappingURL=guidance.js.map

package/dist/guidance.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/http.d.ts

@@ -0,0 +1,8 @@
+import { OdinClient } from './client.js';
+import { OdinMcpServerOptions } from './server.js';
+import '@modelcontextprotocol/sdk/server/mcp.js';
+
+/** The host authenticates every request before calling this adapter. */
+declare function handleOdinMcpRequest(request: Request, client: OdinClient, options?: OdinMcpServerOptions): Promise<Response>;
+
+export { handleOdinMcpRequest };

package/dist/http.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+import {
+  createOdinMcpServer
+} from "./chunk-ODZB3YP2.js";
+import "./chunk-4LCKW236.js";
+import "./chunk-D5FYYTYV.js";
+import "./chunk-XHJYVUHG.js";
+
+// src/http.ts
+import { WebStandardStreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/webStandardStreamableHttp.js";
+async function handleOdinMcpRequest(request, client, options = {}) {
+  if (request.method !== "POST") {
+    return Response.json(
+      { error: "This MCP endpoint supports POST requests only" },
+      { status: 405, headers: { Allow: "POST" } }
+    );
+  }
+  const server = createOdinMcpServer(client, options);
+  const transport = new WebStandardStreamableHTTPServerTransport({
+    sessionIdGenerator: void 0,
+    enableJsonResponse: true,
+    maxRequestBodySize: 1024 * 1024
+  });
+  try {
+    await server.connect(transport);
+    return await transport.handleRequest(request);
+  } finally {
+    await server.close();
+  }
+}
+export {
+  handleOdinMcpRequest
+};
+//# sourceMappingURL=http.js.map

package/dist/http.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/http.ts"],"sourcesContent":["import { WebStandardStreamableHTTPServerTransport } from \"@modelcontextprotocol/sdk/server/webStandardStreamableHttp.js\";\nimport type { OdinClient } from \"./client.js\";\nimport { createOdinMcpServer, type OdinMcpServerOptions } from \"./server.js\";\n\n/** The host authenticates every request before calling this adapter. */\nexport async function handleOdinMcpRequest(\n  request: Request,\n  client: OdinClient,\n  options: OdinMcpServerOptions = {},\n): Promise<Response> {\n  if (request.method !== \"POST\") {\n    return Response.json(\n      { error: \"This MCP endpoint supports POST requests only\" },\n      { status: 405, headers: { Allow: \"POST\" } },\n    );\n  }\n  const server = createOdinMcpServer(client, options);\n  const transport = new WebStandardStreamableHTTPServerTransport({\n    sessionIdGenerator: undefined,\n    enableJsonResponse: true,\n    maxRequestBodySize: 1024 * 1024,\n  });\n  try {\n    await server.connect(transport);\n    return await transport.handleRequest(request);\n  } finally {\n    await server.close();\n  }\n}\n"],"mappings":";;;;;;;;;AAAA,SAAS,gDAAgD;AAKzD,eAAsB,qBACpB,SACA,QACA,UAAgC,CAAC,GACd;AACnB,MAAI,QAAQ,WAAW,QAAQ;AAC7B,WAAO,SAAS;AAAA,MACd,EAAE,OAAO,gDAAgD;AAAA,MACzD,EAAE,QAAQ,KAAK,SAAS,EAAE,OAAO,OAAO,EAAE;AAAA,IAC5C;AAAA,EACF;AACA,QAAM,SAAS,oBAAoB,QAAQ,OAAO;AAClD,QAAM,YAAY,IAAI,yCAAyC;AAAA,IAC7D,oBAAoB;AAAA,IACpB,oBAAoB;AAAA,IACpB,oBAAoB,OAAO;AAAA,EAC7B,CAAC;AACD,MAAI;AACF,UAAM,OAAO,QAAQ,SAAS;AAC9B,WAAO,MAAM,UAAU,cAAc,OAAO;AAAA,EAC9C,UAAE;AACA,UAAM,OAAO,MAAM;AAAA,EACrB;AACF;","names":[]}