fastmcp 1.9.0 → 1.11.0

package/src/FastMCP.test.ts

@@ -10,16 +10,17 @@ import {
   ListRootsRequestSchema,
   LoggingMessageNotificationSchema,
   McpError,
+  PingRequestSchema,
   Root,
 } from "@modelcontextprotocol/sdk/types.js";
 
 const runWithTestServer = async ({
   run,
-  client: clientOverride,
-  start,
+  client: createClient,
+  server: createServer,
 }: {
-  start: () => Promise<FastMCP>;
-  client?: Client;
+  server?: () => Promise<FastMCP>;
+  client?: () => Promise<Client>;
   run: ({
     client,
     server,
@@ -31,7 +32,12 @@ const runWithTestServer = async ({
 }) => {
   const port = await getRandomPort();
 
-  const server = await start();
+  const server = createServer
+    ? await createServer()
+    : new FastMCP({
+        name: "Test",
+        version: "1.0.0",
+      });
 
   await server.start({
     transportType: "sse",
@@ -42,17 +48,17 @@ const runWithTestServer = async ({
   });
 
   try {
-    const client =
-      clientOverride ??
-      new Client(
-        {
-          name: "example-client",
-          version: "1.0.0",
-        },
-        {
-          capabilities: {},
-        },
-      );
+    const client = createClient
+      ? await createClient()
+      : new Client(
+          {
+            name: "example-client",
+            version: "1.0.0",
+          },
+          {
+            capabilities: {},
+          },
+        );
 
     const transport = new SSEClientTransport(
       new URL(`http://localhost:${port}/sse`),
@@ -76,7 +82,7 @@ const runWithTestServer = async ({
 
 test("adds tools", async () => {
   await runWithTestServer({
-    start: async () => {
+    server: async () => {
       const server = new FastMCP({
         name: "Test",
         version: "1.0.0",
@@ -121,7 +127,7 @@ test("adds tools", async () => {
 
 test("calls a tool", async () => {
   await runWithTestServer({
-    start: async () => {
+    server: async () => {
       const server = new FastMCP({
         name: "Test",
         version: "1.0.0",
@@ -159,7 +165,7 @@ test("calls a tool", async () => {
 
 test("returns a list", async () => {
   await runWithTestServer({
-    start: async () => {
+    server: async () => {
       const server = new FastMCP({
         name: "Test",
         version: "1.0.0",
@@ -205,7 +211,7 @@ test("returns a list", async () => {
 
 test("returns an image", async () => {
   await runWithTestServer({
-    start: async () => {
+    server: async () => {
       const server = new FastMCP({
         name: "Test",
         version: "1.0.0",
@@ -254,7 +260,7 @@ test("returns an image", async () => {
 
 test("handles UserError errors", async () => {
   await runWithTestServer({
-    start: async () => {
+    server: async () => {
       const server = new FastMCP({
         name: "Test",
         version: "1.0.0",
@@ -293,7 +299,7 @@ test("handles UserError errors", async () => {
 
 test("calling an unknown tool throws McpError with MethodNotFound code", async () => {
   await runWithTestServer({
-    start: async () => {
+    server: async () => {
       const server = new FastMCP({
         name: "Test",
         version: "1.0.0",
@@ -322,7 +328,7 @@ test("calling an unknown tool throws McpError with MethodNotFound code", async (
 
 test("tracks tool progress", async () => {
   await runWithTestServer({
-    start: async () => {
+    server: async () => {
       const server = new FastMCP({
         name: "Test",
         version: "1.0.0",
@@ -377,12 +383,6 @@ test("tracks tool progress", async () => {
 
 test("sets logging levels", async () => {
   await runWithTestServer({
-    start: async () => {
-      return new FastMCP({
-        name: "Test",
-        version: "1.0.0",
-      });
-    },
     run: async ({ client, session }) => {
       await client.setLoggingLevel("debug");
 
@@ -397,7 +397,7 @@ test("sets logging levels", async () => {
 
 test("sends logging messages to the client", async () => {
   await runWithTestServer({
-    start: async () => {
+    server: async () => {
       const server = new FastMCP({
         name: "Test",
         version: "1.0.0",
@@ -473,7 +473,7 @@ test("sends logging messages to the client", async () => {
 
 test("adds resources", async () => {
   await runWithTestServer({
-    start: async () => {
+    server: async () => {
       const server = new FastMCP({
         name: "Test",
         version: "1.0.0",
@@ -508,7 +508,7 @@ test("adds resources", async () => {
 
 test("adds prompts", async () => {
   await runWithTestServer({
-    start: async () => {
+    server: async () => {
       const server = new FastMCP({
         name: "Test",
         version: "1.0.0",
@@ -532,6 +532,26 @@ test("adds prompts", async () => {
       return server;
     },
     run: async ({ client }) => {
+      expect(
+        await client.getPrompt({
+          name: "git-commit",
+          arguments: {
+            changes: "foo",
+          },
+        }),
+      ).toEqual({
+        description: "Generate a Git commit message",
+        messages: [
+          {
+            role: "user",
+            content: {
+              type: "text",
+              text: "Generate a concise but descriptive commit message for these changes:\n\nfoo",
+            },
+          },
+        ],
+      });
+
       expect(await client.listPrompts()).toEqual({
         prompts: [
           {
@@ -665,40 +685,34 @@ test("handles multiple clients", async () => {
 });
 
 test("session knows about client capabilities", async () => {
-  const client = new Client(
-    {
-      name: "example-client",
-      version: "1.0.0",
-    },
-    {
-      capabilities: {
-        roots: {
-          listChanged: true,
+  await runWithTestServer({
+    client: async () => {
+      const client = new Client(
+        {
+          name: "example-client",
+          version: "1.0.0",
         },
-      },
-    },
-  );
-
-  client.setRequestHandler(ListRootsRequestSchema, () => {
-    return {
-      roots: [
         {
-          uri: "file:///home/user/projects/frontend",
-          name: "Frontend Repository",
+          capabilities: {
+            roots: {
+              listChanged: true,
+            },
+          },
         },
-      ],
-    };
-  });
+      );
 
-  await runWithTestServer({
-    client,
-    start: async () => {
-      const server = new FastMCP({
-        name: "Test",
-        version: "1.0.0",
+      client.setRequestHandler(ListRootsRequestSchema, () => {
+        return {
+          roots: [
+            {
+              uri: "file:///home/user/projects/frontend",
+              name: "Frontend Repository",
+            },
+          ],
+        };
       });
 
-      return server;
+      return client;
     },
     run: async ({ session }) => {
       expect(session.clientCapabilities).toEqual({
@@ -711,40 +725,34 @@ test("session knows about client capabilities", async () => {
 });
 
 test("session knows about roots", async () => {
-  const client = new Client(
-    {
-      name: "example-client",
-      version: "1.0.0",
-    },
-    {
-      capabilities: {
-        roots: {
-          listChanged: true,
+  await runWithTestServer({
+    client: async () => {
+      const client = new Client(
+        {
+          name: "example-client",
+          version: "1.0.0",
         },
-      },
-    },
-  );
-
-  client.setRequestHandler(ListRootsRequestSchema, () => {
-    return {
-      roots: [
         {
-          uri: "file:///home/user/projects/frontend",
-          name: "Frontend Repository",
+          capabilities: {
+            roots: {
+              listChanged: true,
+            },
+          },
         },
-      ],
-    };
-  });
+      );
 
-  await runWithTestServer({
-    client,
-    start: async () => {
-      const server = new FastMCP({
-        name: "Test",
-        version: "1.0.0",
+      client.setRequestHandler(ListRootsRequestSchema, () => {
+        return {
+          roots: [
+            {
+              uri: "file:///home/user/projects/frontend",
+              name: "Frontend Repository",
+            },
+          ],
+        };
       });
 
-      return server;
+      return client;
     },
     run: async ({ session }) => {
       expect(session.roots).toEqual([
@@ -758,20 +766,6 @@ test("session knows about roots", async () => {
 });
 
 test("session listens to roots changes", async () => {
-  const client = new Client(
-    {
-      name: "example-client",
-      version: "1.0.0",
-    },
-    {
-      capabilities: {
-        roots: {
-          listChanged: true,
-        },
-      },
-    },
-  );
-
   let clientRoots: Root[] = [
     {
       uri: "file:///home/user/projects/frontend",
@@ -779,23 +773,31 @@ test("session listens to roots changes", async () => {
     },
   ];
 
-  client.setRequestHandler(ListRootsRequestSchema, () => {
-    return {
-      roots: clientRoots,
-    };
-  });
-
   await runWithTestServer({
-    client,
-    start: async () => {
-      const server = new FastMCP({
-        name: "Test",
-        version: "1.0.0",
+    client: async () => {
+      const client = new Client(
+        {
+          name: "example-client",
+          version: "1.0.0",
+        },
+        {
+          capabilities: {
+            roots: {
+              listChanged: true,
+            },
+          },
+        },
+      );
+
+      client.setRequestHandler(ListRootsRequestSchema, () => {
+        return {
+          roots: clientRoots,
+        };
       });
 
-      return server;
+      return client;
     },
-    run: async ({ session }) => {
+    run: async ({ session, client }) => {
       expect(session.roots).toEqual([
         {
           uri: "file:///home/user/projects/frontend",
@@ -843,3 +845,122 @@ test("session listens to roots changes", async () => {
     },
   });
 });
+
+test("session sends pings to the client", async () => {
+  await runWithTestServer({
+    run: async ({ client }) => {
+      const onPing = vi.fn().mockReturnValue({});
+
+      client.setRequestHandler(PingRequestSchema, onPing);
+
+      await delay(2000);
+
+      expect(onPing).toHaveBeenCalledTimes(1);
+    },
+  });
+});
+
+test("prompt argument autocompletion", async () => {
+  await runWithTestServer({
+    server: async () => {
+      const server = new FastMCP({
+        name: "Test",
+        version: "1.0.0",
+      });
+
+      server.addPrompt({
+        name: "countryPoem",
+        description: "Writes a poem about a country",
+        load: async ({ name }) => {
+          return `Hello, ${name}!`;
+        },
+        arguments: [
+          {
+            name: "name",
+            description: "Name of the country",
+            required: true,
+            complete: async (value) => {
+              if (value === "Germ") {
+                return {
+                  values: ["Germany"],
+                };
+              }
+
+              return {
+                values: [],
+              };
+            },
+          },
+        ],
+      });
+
+      return server;
+    },
+    run: async ({ client }) => {
+      const response = await client.complete({
+        ref: {
+          type: "ref/prompt",
+          name: "countryPoem",
+        },
+        argument: {
+          name: "name",
+          value: "Germ",
+        },
+      });
+
+      expect(response).toEqual({
+        completion: {
+          values: ["Germany"],
+        },
+      });
+    },
+  });
+});
+
+test("adds automatic prompt argument completion when enum is provided", async () => {
+  await runWithTestServer({
+    server: async () => {
+      const server = new FastMCP({
+        name: "Test",
+        version: "1.0.0",
+      });
+
+      server.addPrompt({
+        name: "countryPoem",
+        description: "Writes a poem about a country",
+        load: async ({ name }) => {
+          return `Hello, ${name}!`;
+        },
+        arguments: [
+          {
+            name: "name",
+            description: "Name of the country",
+            required: true,
+            enum: ["Germany", "France", "Italy"],
+          },
+        ],
+      });
+
+      return server;
+    },
+    run: async ({ client }) => {
+      const response = await client.complete({
+        ref: {
+          type: "ref/prompt",
+          name: "countryPoem",
+        },
+        argument: {
+          name: "name",
+          value: "Germ",
+        },
+      });
+
+      expect(response).toEqual({
+        completion: {
+          values: ["Germany"],
+          total: 1,
+        },
+      });
+    },
+  });
+});