@ontrails/mcp 1.0.0-beta.16 → 1.0.0-beta.17

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @ontrails/mcp
 
+## 1.0.0-beta.17
+
+### Patch Changes
+
+- 61497c5: Add v1-minimum public API examples for shipped surface entrypoints.
+- Updated dependencies [3dc8254]
+  - @ontrails/core@1.0.0-beta.17
+
 ## 1.0.0-beta.16
 
 ### Minor Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ontrails/mcp",
-  "version": "1.0.0-beta.16",
+  "version": "1.0.0-beta.17",
   "files": [
     "src/**/*.ts",
     "!src/**/__tests__/**",
@@ -22,7 +22,7 @@
     "clean": "rm -rf dist *.tsbuildinfo"
   },
   "dependencies": {
-    "@ontrails/core": "^1.0.0-beta.15"
+    "@ontrails/core": "^1.0.0-beta.16"
   },
   "peerDependencies": {
     "@modelcontextprotocol/sdk": "^1.28.0",

package/src/build.ts

@@ -950,6 +950,21 @@ const registerTools = (
   return Result.ok(tools);
 };
 
+/**
+ * Build MCP tool definitions from a topo without opening a transport.
+ *
+ * @example
+ * ```ts
+ * import { deriveMcpTools } from '@ontrails/mcp';
+ *
+ * const tools = deriveMcpTools(graph, { include: ['entity.**'] });
+ * if (tools.isErr()) throw tools.error;
+ *
+ * for (const tool of tools.value) {
+ *   console.log(tool.name);
+ * }
+ * ```
+ */
 export const deriveMcpTools = (
   graph: Topo,
   options: DeriveMcpToolsOptions = {}

package/src/stdio.ts

@@ -10,6 +10,14 @@ import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js'
 
 /**
  * Connect an MCP server to stdio transport.
+ *
+ * @example
+ * ```ts
+ * import { connectStdio, createServer } from '@ontrails/mcp';
+ *
+ * const server = createServer(graph);
+ * await connectStdio(server);
+ * ```
  */
 export const connectStdio = async (server: Server): Promise<void> => {
   const transport = new StdioServerTransport();

package/src/surface.ts

@@ -162,6 +162,14 @@ const createMcpServer = (
  * @remarks This is a host materialization boundary. Derivation failures are
  * thrown for server bootstrap code after `deriveMcpTools` has already
  * represented the framework error as a Result.
+ *
+ * @example
+ * ```ts
+ * import { connectStdio, createServer } from '@ontrails/mcp';
+ *
+ * const server = createServer(graph, { name: 'demo' });
+ * await connectStdio(server);
+ * ```
  */
 export const createServer = (
   graph: Topo,
@@ -199,6 +207,13 @@ export const createServer = (
  *
  * @remarks Opens the MCP server on stdio. For custom transports, use
  * `createServer(graph)` with `connectStdio` or your own adapter.
+ *
+ * @example
+ * ```ts
+ * import { surface } from '@ontrails/mcp';
+ *
+ * await surface(graph, { name: 'demo' });
+ * ```
  */
 export const surface = async (
   graph: Topo,