@emseepea/create-api-backed-server 0.0.7 → 0.0.9

package/initializer-dist/template/package.json

@@ -25,7 +25,7 @@
   },
   "private": true,
   "dependencies": {
-    "@emseepea/server": "0.3.0",
+    "@emseepea/server": "0.3.2",
     "zod": "4.4.3"
   }
 }

package/initializer-dist/template/src/capabilities/tool.search-pea-taxa.ts

@@ -4,29 +4,28 @@ import { z } from "zod";
 
 export interface BackendExampleContext { readonly client: JsonHttpClient }
 
-const taxon = z.object({
-  id: z.number().int().positive(),
-  name: z.string().min(1).max(200),
-  preferred_common_name: z.string().min(1).max(200).nullable().optional(),
-  rank: z.string().min(1).max(40),
-  observations_count: z.number().int().nonnegative(),
-});
 const backendTaxon = z.object({
-  id: z.number().int().positive(),
-  name: z.string().min(1).max(200),
-  preferred_common_name: z.string().min(1).max(200).nullable().optional(),
-  rank: z.string().min(1).max(40),
-  observations_count: z.number().int().nonnegative(),
+  id: z.number().int().positive().describe("iNaturalist identifier for the taxon."),
+  name: z.string().min(1).max(200).describe("Scientific name of the taxon."),
+  preferred_common_name: z.string().min(1).max(200).nullable().optional()
+    .describe("Preferred common name when iNaturalist provides one."),
+  rank: z.string().min(1).max(40).describe("Taxonomic rank reported by iNaturalist."),
+  observations_count: z.number().int().nonnegative()
+    .describe("Recorded iNaturalist observations, not an estimate of the wild population."),
+});
+const inputSchema = z.object({
+  query: z.string().trim().min(2).max(80).describe("Pea name or other taxon search terms."),
+});
+const backendPayload = z.object({
+  total_results: z.number().int().nonnegative().describe("Total matching taxa reported by iNaturalist."),
+  results: z.array(backendTaxon).max(5).describe("Up to five matching taxa."),
 });
-const searchInput = z.object({ query: z.string().trim().min(2).max(80) });
-const searchReport = z.object({
-  query: z.string().max(80),
-  total_results: z.number().int().nonnegative(),
-  results: z.array(taxon).max(5),
-  source: z.literal("iNaturalist"),
-  source_url: z.literal("https://www.inaturalist.org"),
+const outputSchema = backendPayload.extend({
+  query: z.string().max(80).describe("Trimmed search terms sent to iNaturalist."),
+  source: z.literal("iNaturalist").describe("Data provider for these results."),
+  source_url: z.literal("https://www.inaturalist.org").describe("Website of the data provider."),
 });
-const backendCommand = z.object({
+const backendInputSchema = z.object({
   pathname: z.literal("/v1/taxa"),
   searchParams: z.object({
     q: z.string().min(2).max(80),
@@ -34,20 +33,16 @@ const backendCommand = z.object({
     per_page: z.literal("5"),
   }),
 });
-const backendPayload = z.object({
-  total_results: z.number().int().nonnegative(),
-  results: z.array(backendTaxon).max(5),
-});
-const backendResult = z.object({ request: backendCommand, payload: backendPayload });
+const backendOutputSchema = z.object({ request: backendInputSchema, payload: backendPayload });
 
 export default (({ client }) => defineMappedTool({
   name: "search-pea-taxa",
   access: "public",
   description: "Search iNaturalist's public taxon catalogue for pea species.",
-  inputSchema: searchInput,
-  outputSchema: searchReport,
-  backendInputSchema: backendCommand,
-  backendOutputSchema: backendResult,
+  inputSchema,
+  outputSchema,
+  backendInputSchema,
+  backendOutputSchema,
   mapInput: ({ query }) => ({
     pathname: "/v1/taxa" as const,
     searchParams: { q: query, rank: "species" as const, per_page: "5" as const },
@@ -57,15 +52,8 @@ export default (({ client }) => defineMappedTool({
   },
   mapOutput: ({ request, payload }) => {
     const data = {
+      ...payload,
       query: request.searchParams.q,
-      total_results: payload.total_results,
-      results: payload.results.map((record) => ({
-        id: record.id,
-        name: record.name,
-        preferred_common_name: record.preferred_common_name,
-        rank: record.rank,
-        observations_count: record.observations_count,
-      })),
       source: "iNaturalist" as const,
       source_url: "https://www.inaturalist.org" as const,
     };

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

@@ -25,6 +25,19 @@ test("the API-backed example checks and passes through selected iNaturalist valu
   try {
     const listed = await client.listTools();
     assert.deepEqual(listed.tools.map(({ name }) => name), ["search-pea-taxa"]);
+    const tool = listed.tools[0];
+    assert.equal(tool.inputSchema.properties.query.description, "Pea name or other taxon search terms.");
+    assert.equal(tool.outputSchema.properties.total_results.description, "Total matching taxa reported by iNaturalist.");
+    assert.equal(tool.outputSchema.properties.results.description, "Up to five matching taxa.");
+    const taxon = tool.outputSchema.properties.results.items.properties;
+    assert.equal(taxon.id.description, "iNaturalist identifier for the taxon.");
+    assert.equal(taxon.name.description, "Scientific name of the taxon.");
+    assert.equal(taxon.preferred_common_name.description, "Preferred common name when iNaturalist provides one.");
+    assert.equal(taxon.rank.description, "Taxonomic rank reported by iNaturalist.");
+    assert.equal(taxon.observations_count.description, "Recorded iNaturalist observations, not an estimate of the wild population.");
+    assert.equal(tool.outputSchema.properties.query.description, "Trimmed search terms sent to iNaturalist.");
+    assert.equal(tool.outputSchema.properties.source.description, "Data provider for these results.");
+    assert.equal(tool.outputSchema.properties.source_url.description, "Website of the data provider.");
 
     const invalidInput = await client.callTool({
       name: "search-pea-taxa",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emseepea/create-api-backed-server",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Create an Em See Pea server backed by a public web API.",
   "license": "MIT",
   "type": "module",
@@ -18,7 +18,7 @@
     "prepack": "npm run build:initializer"
   },
   "devDependencies": {
-    "@emseepea/server": "0.3.0",
+    "@emseepea/server": "0.3.2",
     "zod": "4.4.3",
     "@emseepea/testing": "0.3.0",
     "@modelcontextprotocol/client": "2.0.0",