@emseepea/create-mongodb-backed-server 0.0.0 → 0.0.2

package/README.md

@@ -27,6 +27,30 @@ tests.
 
 <!-- generated-project-readme -->
 
+## Choose Open or Protected Access
+
+Start open when the catalogue and operations are public.
+
+To protect this template, pass both options to the app factory:
+
+- `access: { access: "protected", requiredScopes: ["peas:read"] }`
+- an `authentication` adapter
+
+Keep `authentication.discovery` as `"public"` unless capability names or
+schemas are sensitive. Use `"protected"` only when each principal should see a
+permission-filtered catalogue. OAuth metadata remains public in both modes.
+
+## Add Observability
+
+The same factory accepts `observability`.
+
+- Use `structuredLogging` for safe structured events.
+- Use `openTelemetry` for traces and metrics.
+
+Adapters receive only redacted framework events. They never receive request
+bodies, arguments, results, tokens, provider claims, or raw errors. See the
+[server API](https://github.com/emseepea/emseepea/tree/main/packages/framework#authentication-and-observability) for the complete configuration.
+
 ## MongoDB-Backed Server
 
 `pea_varieties` is schema-enforced. `src/pea-document.ts` contains its only

package/initializer-dist/template/README.md

@@ -1,4 +1,28 @@
-# MongoDB-Backed Server
+# Choose Open or Protected Access
+
+Start open when the catalogue and operations are public.
+
+To protect this template, pass both options to the app factory:
+
+- `access: { access: "protected", requiredScopes: ["peas:read"] }`
+- an `authentication` adapter
+
+Keep `authentication.discovery` as `"public"` unless capability names or
+schemas are sensitive. Use `"protected"` only when each principal should see a
+permission-filtered catalogue. OAuth metadata remains public in both modes.
+
+## Add Observability
+
+The same factory accepts `observability`.
+
+- Use `structuredLogging` for safe structured events.
+- Use `openTelemetry` for traces and metrics.
+
+Adapters receive only redacted framework events. They never receive request
+bodies, arguments, results, tokens, provider claims, or raw errors. See the
+[server API](https://github.com/emseepea/emseepea/tree/main/packages/framework#authentication-and-observability) for the complete configuration.
+
+## MongoDB-Backed Server
 
 `pea_varieties` is schema-enforced. `src/pea-document.ts` contains its only
 stored-document schema. MongoDB applies that exact object as its collection

package/initializer-dist/template/package.json

@@ -16,7 +16,7 @@
     "lint": "oxlint src test eval"
   },
   "devDependencies": {
-    "@emseepea/testing": "0.5.2",
+    "@emseepea/testing": "0.6.1",
     "@types/node": "24.13.3",
     "typescript": "6.0.3",
     "oxlint": "1.80.0"
@@ -26,7 +26,7 @@
   },
   "private": true,
   "dependencies": {
-    "@emseepea/server": "0.3.3",
+    "@emseepea/server": "0.4.0",
     "ajv": "8.20.0",
     "json-schema-to-ts": "3.1.1",
     "mongodb": "7.6.0",

package/initializer-dist/template/src/app.ts

@@ -1,13 +1,26 @@
-import { createEmseepea, discoverCapabilities } from "@emseepea/server";
+import {
+  createEmseepea,
+  discoverCapabilities,
+  type AccessPolicy,
+  type EmseepeaExtensions,
+} from "@emseepea/server";
 import type { Collection, Db } from "mongodb";
 import { z } from "zod";
 import { createDatabase } from "./database.js";
 import type { PeaObservationDocument } from "./pea-observation-document.js";
 import type { PeaDocument } from "./pea-document.js";
 
-export interface MongoExampleOptions { readonly uri: string }
+export interface MongoExampleOptions extends EmseepeaExtensions {
+  readonly uri: string;
+  readonly access?: AccessPolicy;
+}
 
-export async function createMongoExample({ uri }: MongoExampleOptions) {
+export async function createMongoExample({
+  uri,
+  access = { access: "public" },
+  authentication,
+  observability,
+}: MongoExampleOptions) {
   const parsedUri = z.string().url().refine(
     (value) => ["mongodb:", "mongodb+srv:"].includes(new URL(value).protocol),
     "uri must use MongoDB",
@@ -33,10 +46,13 @@ export async function createMongoExample({ uri }: MongoExampleOptions) {
     },
     readinessTimeoutMs: 2_500,
     ...await discoverCapabilities(new URL("./capabilities/", import.meta.url), {
+      access,
       database: () => database,
       observations: () => observations,
       varieties: () => varieties,
     }),
+    authentication,
+    observability,
   });
   const closeProvider = async () => {
     observations = undefined;

package/initializer-dist/template/src/capabilities/tool.add-pea-variety.ts

@@ -1,5 +1,5 @@
 import { randomUUID } from "node:crypto";
-import { defineTool, type CapabilityModuleFactory } from "@emseepea/server";
+import { defineTool, type CapabilityModuleFactory, type ToolContext } from "@emseepea/server";
 import { parsePeaDocument } from "../pea-document.js";
 import { varietySchema } from "../pea-variety.js";
 import type { MongoContext } from "../database.js";
@@ -9,11 +9,11 @@ const outputSchema = varietySchema;
 
 export default ((context) => defineTool({
   name: "add-pea-variety",
-  access: "public",
+  ...context.access,
   description: "Add one pea variety to the catalogue.",
   inputSchema,
   outputSchema,
-  async handler(variety, { signal }) {
+  async handler(variety, { signal }: ToolContext) {
     const collection = context.varieties();
     if (!collection) throw new Error("Variety provider unavailable");
     signal.throwIfAborted();

package/initializer-dist/template/src/capabilities/tool.list-pea-observations.ts

@@ -1,4 +1,4 @@
-import { defineTool, type CapabilityModuleFactory } from "@emseepea/server";
+import { defineTool, type CapabilityModuleFactory, type ToolContext } from "@emseepea/server";
 import { z } from "zod";
 import type { MongoContext } from "../database.js";
 import { parsePeaObservationDocument } from "../pea-observation-document.js";
@@ -15,11 +15,11 @@ const outputSchema = z.object({
 
 export default ((context) => defineTool({
   name: "list-pea-observations",
-  access: "public",
+  ...context.access,
   description: "List up to 20 recent observations of pea plants.",
   inputSchema,
   outputSchema,
-  async handler({ variety_name }, { signal }) {
+  async handler({ variety_name }, { signal }: ToolContext) {
     const collection = context.observations();
     if (!collection) throw new Error("Observation provider unavailable");
     signal.throwIfAborted();

package/initializer-dist/template/src/capabilities/tool.list-pea-varieties.ts

@@ -1,4 +1,4 @@
-import { defineTool, type CapabilityModuleFactory } from "@emseepea/server";
+import { defineTool, type CapabilityModuleFactory, type ToolContext } from "@emseepea/server";
 import { z } from "zod";
 import { parsePeaDocument } from "../pea-document.js";
 import { varietySchema } from "../pea-variety.js";
@@ -14,11 +14,11 @@ const outputSchema = z.object({
 
 export default ((context) => defineTool({
   name: "list-pea-varieties",
-  access: "public",
+  ...context.access,
   description: "List up to 20 pea varieties, optionally filtered by pea type.",
   inputSchema,
   outputSchema,
-  async handler({ pea_type }, { signal }) {
+  async handler({ pea_type }, { signal }: ToolContext) {
     const collection = context.varieties();
     if (!collection) throw new Error("Variety provider unavailable");
     signal.throwIfAborted();

package/initializer-dist/template/src/capabilities/tool.record-pea-observation.ts

@@ -1,5 +1,5 @@
 import { randomUUID } from "node:crypto";
-import { defineTool, type CapabilityModuleFactory } from "@emseepea/server";
+import { defineTool, type CapabilityModuleFactory, type ToolContext } from "@emseepea/server";
 import type { MongoContext } from "../database.js";
 import { parsePeaObservationDocument } from "../pea-observation-document.js";
 import { observationSchema } from "../pea-observation.js";
@@ -9,11 +9,11 @@ const outputSchema = observationSchema;
 
 export default ((context) => defineTool({
   name: "record-pea-observation",
-  access: "public",
+  ...context.access,
   description: "Record one dated observation of a pea plant.",
   inputSchema,
   outputSchema,
-  async handler(observation, { signal }) {
+  async handler(observation, { signal }: ToolContext) {
     const collection = context.observations();
     if (!collection) throw new Error("Observation provider unavailable");
     signal.throwIfAborted();

package/initializer-dist/template/src/database.ts

@@ -1,4 +1,5 @@
 import { MongoClient, type Collection, type Db } from "mongodb";
+import type { AccessPolicy } from "@emseepea/server";
 import type { PeaObservationDocument } from "./pea-observation-document.js";
 import type { PeaDocument } from "./pea-document.js";
 
@@ -23,6 +24,7 @@ export function createDatabase(uri: string) {
 }
 
 export interface MongoContext {
+  readonly access: AccessPolicy;
   readonly varieties: () => Collection<PeaDocument> | undefined;
   readonly observations: () => Collection<PeaObservationDocument> | undefined;
   readonly database: () => Db | undefined;

package/initializer-dist/template/test/server.test.mjs

@@ -2,7 +2,11 @@ import assert from "node:assert/strict";
 import { spawnSync } from "node:child_process";
 import test, { after } from "node:test";
 
-import { startMcpServer } from "@emseepea/testing";
+import {
+  insecureTestAuthentication,
+  startEmseepea,
+  startMcpServer,
+} from "@emseepea/testing";
 import { MongoClient } from "mongodb";
 import { createMongoExample } from "../dist/app.js";
 import {
@@ -57,6 +61,22 @@ test("each collection has one application schema and only varieties enforce it i
   ]);
 });
 
+test("the same template composes protected access and observability", async (t) => {
+  const events = [];
+  const permissions = ["catalogue:write"];
+  const { app } = await createMongoExample({
+    uri,
+    access: { access: "protected", requiredScopes: permissions },
+    authentication: insecureTestAuthentication(permissions),
+    observability: [{ id: "test-log", emit: (event) => events.push(event) }],
+  });
+  const running = await startEmseepea(t, app);
+  const client = await running.connect("test-token");
+  const result = await client.callTool({ name: "list-pea-varieties", arguments: {} });
+  assert.equal(result.isError, false);
+  assert.ok(events.some(({ capability }) => capability === "list-pea-varieties"));
+});
+
 test("setup fails closed when the schemaless collection already has a validator", async () => {
   await database.command({
     collMod: observationCollectionName,

package/package.json

@@ -1,16 +1,10 @@
 {
   "name": "@emseepea/create-mongodb-backed-server",
-  "version": "0.0.0",
+  "version": "0.0.2",
   "description": "Create an Em See Pea server with schema-enforced and schemaless MongoDB collections.",
   "license": "MIT",
   "type": "module",
-  "starterDependencies": [
-    "@emseepea/server",
-    "ajv",
-    "json-schema-to-ts",
-    "mongodb",
-    "zod"
-  ],
+  "starterDependencies": ["@emseepea/server", "ajv", "json-schema-to-ts", "mongodb", "zod"],
   "scripts": {
     "build": "npm run build:example && npm run build:initializer",
     "build:example": "tsc -p tsconfig.json",
@@ -26,34 +20,21 @@
     "prepack": "npm run build:initializer"
   },
   "devDependencies": {
-    "@emseepea/server": "0.3.3",
+    "@emseepea/server": "0.4.0",
     "ajv": "8.20.0",
     "json-schema-to-ts": "3.1.1",
     "mongodb": "7.6.0",
     "zod": "4.4.3",
-    "@emseepea/testing": "0.5.3",
+    "@emseepea/testing": "0.6.1",
     "@types/node": "24.13.3",
     "typescript": "6.0.3",
     "oxlint": "1.80.0"
   },
-  "engines": {
-    "node": ">=22.13.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/emseepea/emseepea.git",
-    "directory": "examples/mongodb-backed-server"
-  },
+  "engines": { "node": ">=22.13.0" },
+  "repository": { "type": "git", "url": "git+https://github.com/emseepea/emseepea.git", "directory": "examples/mongodb-backed-server" },
   "homepage": "https://emseepea.github.io/emseepea/examples/",
   "bugs": "https://github.com/emseepea/emseepea/issues",
-  "publishConfig": {
-    "access": "public",
-    "provenance": true
-  },
-  "bin": {
-    "create-mongodb-backed-server": "./initializer-dist/create.mjs"
-  },
-  "files": [
-    "initializer-dist"
-  ]
+  "publishConfig": { "access": "public", "provenance": true },
+  "bin": { "create-mongodb-backed-server": "./initializer-dist/create.mjs" },
+  "files": ["initializer-dist"]
 }