fix: Add missing pagination parameters to various tools (#45)

Author: egorpavlikhin

src/tools/listDeployments.ts

@@ -10,62 +10,68 @@ export function registerListDeploymentsTool(server: McpServer) {
     `List deployments in a space
   
   This tool lists deployments in a given space. The space name is required. When requesting latest deployment consider which deployment state the user is interested in (successful or all). Optional filters include: projects (array of project IDs), environments (array of environment IDs), tenants (array of tenant IDs), channels (array of channel IDs), taskState (one of: Canceled, Cancelling, Executing, Failed, Queued, Success, TimedOut), and take (number of results to return).`,
-    { 
-      spaceName: z.string(), 
+    {
+      spaceName: z.string(),
       projects: z.array(z.string()).optional(),
       environments: z.array(z.string()).optional(),
       tenants: z.array(z.string()).optional(),
       channels: z.array(z.string()).optional(),
       taskState: z.enum(["Canceled", "Cancelling", "Executing", "Failed", "Queued", "Success", "TimedOut"]).optional(),
+      skip: z.number().optional(),
       take: z.number().optional()
     },
     {
       title: "List deployments in an Octopus Deploy space",
       readOnlyHint: true,
     },
-    async ({ spaceName, projects, environments, tenants, channels, taskState, take }) => {
+    async ({ spaceName, projects, environments, tenants, channels, taskState, skip, take }) => {
       const configuration = getClientConfigurationFromEnvironment();
       const client = await Client.create(configuration);
       const deploymentRepository = new DeploymentRepository(client, spaceName);
 
-      const deploymentsResponse = await deploymentRepository.list({ 
+      const deploymentsResponse = await deploymentRepository.list({
         projects,
         environments,
         tenants,
         channels,
         taskState: taskState ? TaskState[taskState as keyof typeof TaskState] : undefined,
+        skip,
         take
       });
-      
-      const deployments = deploymentsResponse.Items.map((deployment: Deployment) => ({
-        spaceId: deployment.SpaceId,
-        id: deployment.Id,
-        name: deployment.Name,
-        releaseId: deployment.ReleaseId,
-        environmentId: deployment.EnvironmentId,
-        tenantId: deployment.TenantId,
-        projectId: deployment.ProjectId,
-        channelId: deployment.ChannelId,
-        created: deployment.Created,
-        taskId: deployment.TaskId,
-        deploymentProcessId: deployment.DeploymentProcessId,
-        comments: deployment.Comments,
-        formValues: deployment.FormValues,
-        queueTime: deployment.QueueTime,
-        queueTimeExpiry: deployment.QueueTimeExpiry,
-        useGuidedFailure: deployment.UseGuidedFailure,
-        specificMachineIds: deployment.SpecificMachineIds,
-        excludedMachineIds: deployment.ExcludedMachineIds,
-        skipActions: deployment.SkipActions,
-        forcePackageDownload: deployment.ForcePackageDownload,
-        forcePackageRedeployment: deployment.ForcePackageRedeployment,
-      }));
 
       return {
         content: [
           {
             type: "text",
-            text: JSON.stringify(deployments),
+            text: JSON.stringify({
+              totalResults: deploymentsResponse.TotalResults,
+              itemsPerPage: deploymentsResponse.ItemsPerPage,
+              numberOfPages: deploymentsResponse.NumberOfPages,
+              lastPageNumber: deploymentsResponse.LastPageNumber,
+              items: deploymentsResponse.Items.map((deployment: Deployment) => ({
+                spaceId: deployment.SpaceId,
+                id: deployment.Id,
+                name: deployment.Name,
+                releaseId: deployment.ReleaseId,
+                environmentId: deployment.EnvironmentId,
+                tenantId: deployment.TenantId,
+                projectId: deployment.ProjectId,
+                channelId: deployment.ChannelId,
+                created: deployment.Created,
+                taskId: deployment.TaskId,
+                deploymentProcessId: deployment.DeploymentProcessId,
+                comments: deployment.Comments,
+                formValues: deployment.FormValues,
+                queueTime: deployment.QueueTime,
+                queueTimeExpiry: deployment.QueueTimeExpiry,
+                useGuidedFailure: deployment.UseGuidedFailure,
+                specificMachineIds: deployment.SpecificMachineIds,
+                excludedMachineIds: deployment.ExcludedMachineIds,
+                skipActions: deployment.SkipActions,
+                forcePackageDownload: deployment.ForcePackageDownload,
+                forcePackageRedeployment: deployment.ForcePackageRedeployment,
+              }))
+            }),
           },
         ],
       };

src/tools/listEnvironments.ts

@@ -10,33 +10,43 @@ export function registerListEnvironmentsTool(server: McpServer) {
     `List environments in a space
   
   This tool lists all environments in a given space. The space name is required. Use this tool as early as possible to understand which environments are configured. Optionally filter by partial name match using partialName parameter.`,
-    { spaceName: z.string(), partialName: z.string().optional() },
+    {
+      spaceName: z.string(),
+      partialName: z.string().optional(),
+      skip: z.number().optional(),
+      take: z.number().optional()
+    },
     {
       title: "List all environments in an Octopus Deploy space",
       readOnlyHint: true,
     },
-    async ({ spaceName, partialName }) => {
+    async ({ spaceName, partialName, skip, take }) => {
       const configuration = getClientConfigurationFromEnvironment();
       const client = await Client.create(configuration);
       const environmentRepository = new EnvironmentRepository(client, spaceName);
 
-      const environmentsResponse = await environmentRepository.list({ partialName });
-      const environments = environmentsResponse.Items.map((environment: DeploymentEnvironment) => ({
-        spaceId: environment.SpaceId,
-        id: environment.Id,
-        name: environment.Name,
-        description: environment.Description,
-        sortOrder: environment.SortOrder,
-        useGuidedFailure: environment.UseGuidedFailure,
-        allowDynamicInfrastructure: environment.AllowDynamicInfrastructure,
-        extensionSettings: environment.ExtensionSettings,
-      }));
+      const environmentsResponse = await environmentRepository.list({ partialName, skip, take });
 
       return {
         content: [
           {
             type: "text",
-            text: JSON.stringify(environments),
+            text: JSON.stringify({
+              totalResults: environmentsResponse.TotalResults,
+              itemsPerPage: environmentsResponse.ItemsPerPage,
+              numberOfPages: environmentsResponse.NumberOfPages,
+              lastPageNumber: environmentsResponse.LastPageNumber,
+              items: environmentsResponse.Items.map((environment: DeploymentEnvironment) => ({
+                spaceId: environment.SpaceId,
+                id: environment.Id,
+                name: environment.Name,
+                description: environment.Description,
+                sortOrder: environment.SortOrder,
+                useGuidedFailure: environment.UseGuidedFailure,
+                allowDynamicInfrastructure: environment.AllowDynamicInfrastructure,
+                extensionSettings: environment.ExtensionSettings,
+              }))
+            }),
           },
         ],
       };

src/tools/listProjects.ts

@@ -9,37 +9,47 @@ export function registerListProjectsTool(server: McpServer) {
   server.tool(
     "list_projects",
     `This tool lists all projects in a given space. ${projectsDescription} The space name is required, if you can't find the space name, ask the user directly for the name of the space. Optionally filter by partial name match using partialName parameter.`,
-    { spaceName: z.string(), partialName: z.string().optional() },
+    {
+      spaceName: z.string(), 
+      partialName: z.string().optional(),
+      skip: z.number().optional(),
+      take: z.number().optional()
+    },
     {
       title: "List all projects in an Octopus Deploy space",
       readOnlyHint: true,
     },
-    async ({ spaceName, partialName }) => {
+    async ({ spaceName, partialName, skip, take }) => {
       const configuration = getClientConfigurationFromEnvironment();
       const client = await Client.create(configuration);
       const projectRepository = new ProjectRepository(client, spaceName);
 
-      const projectsResponse = await projectRepository.list({ partialName });
-      const projects = projectsResponse.Items.map((project: Project) => ({
-        spaceId: project.SpaceId,
-        id: project.Id,
-        name: project.Name,
-        description: project.Description,
-        slug: project.Slug,
-        deploymentProcessId: project.DeploymentProcessId,
-        lifecycleId: project.LifecycleId,
-        isDisabled: project.IsDisabled,
-        repositoryUrl:
-          project.PersistenceSettings.Type === "VersionControlled"
-            ? project.PersistenceSettings.Url
-            : null,
-      }));
+      const projectsResponse = await projectRepository.list({ partialName, skip, take });
 
       return {
         content: [
           {
             type: "text",
-            text: JSON.stringify(projects),
+            text: JSON.stringify({
+              totalResults: projectsResponse.TotalResults,
+              itemsPerPage: projectsResponse.ItemsPerPage,
+              numberOfPages: projectsResponse.NumberOfPages,
+              lastPageNumber: projectsResponse.LastPageNumber,
+              items: projectsResponse.Items.map((project: Project) => ({
+                spaceId: project.SpaceId,
+                id: project.Id,
+                name: project.Name,
+                description: project.Description,
+                slug: project.Slug,
+                deploymentProcessId: project.DeploymentProcessId,
+                lifecycleId: project.LifecycleId,
+                isDisabled: project.IsDisabled,
+                repositoryUrl:
+                  project.PersistenceSettings.Type === "VersionControlled"
+                    ? project.PersistenceSettings.Url
+                    : null,
+              })),
+            }),
           },
         ],
       };

src/tools/listReleases.ts

@@ -12,8 +12,8 @@ export function registerListReleasesTool(server: McpServer) {
   This tool lists all releases in a given space. The space name is required. Optionally provide skip and take parameters for pagination.`,
     { 
       spaceName: z.string().describe("The space name"),
-      skip: z.number().optional().describe("Number of items to skip for pagination"),
-      take: z.number().optional().describe("Number of items to take for pagination")
+      skip: z.number().optional(),
+      take: z.number().optional()
     },
     {
       title: "List all releases in an Octopus Deploy space",

src/tools/listReleasesForProject.ts

@@ -13,8 +13,8 @@ export function registerListReleasesForProjectTool(server: McpServer) {
     { 
       spaceName: z.string(),
       projectId: z.string(),
-      skip: z.number().optional().describe("Number of items to skip for pagination"),
-      take: z.number().optional().describe("Number of items to take for pagination"),
+      skip: z.number().optional(),
+      take: z.number().optional(),
       searchByVersion: z.string().optional().describe("Search releases by version string")
     },
     {

src/tools/listSpaces.ts

@@ -9,30 +9,39 @@ export function registerListSpacesTool(server: McpServer) {
   server.tool(
     "list_spaces",
     `List all spaces in the Octopus Deploy instance. ${spacesDescription} Always use this tool first to check that the requested space exists.`,
-    { partialName: z.string().optional() },
+    {
+      partialName: z.string().optional(),
+      skip: z.number().optional(),
+      take: z.number().optional()
+    },
     {
       title: "List all spaces in an Octopus Deploy instance",
       readOnlyHint: true,
     },
-    async ({ partialName }) => {
+    async ({ partialName, skip, take }) => {
       const configuration = getClientConfigurationFromEnvironment();
       const client = await Client.create(configuration);
       const spaceRepository = new SpaceRepository(client);
 
-      const spacesResponse = await spaceRepository.list({ partialName });
-      const spaces = spacesResponse.Items.map((space) => ({
-        id: space.Id,
-        name: space.Name,
-        description: space.Description,
-        isDefault: space.IsDefault,
-        taskQueueStopped: space.TaskQueueStopped,
-      }));
+      const spacesResponse = await spaceRepository.list({ partialName, skip, take });
 
       return {
         content: [
           {
             type: "text",
-            text: JSON.stringify(spaces),
+            text: JSON.stringify({
+              totalResults: spacesResponse.TotalResults,
+              itemsPerPage: spacesResponse.ItemsPerPage,
+              numberOfPages: spacesResponse.NumberOfPages,
+              lastPageNumber: spacesResponse.LastPageNumber,
+              items: spacesResponse.Items.map((space) => ({
+                id: space.Id,
+                name: space.Name,
+                description: space.Description,
+                isDefault: space.IsDefault,
+                taskQueueStopped: space.TaskQueueStopped,
+              }))
+            }),
           },
         ],
       };

src/tools/listTenants.ts

@@ -13,8 +13,8 @@ export function registerListTenantsTool(server: McpServer) {
   This tool lists all tenants in a given space. The space name is required. Optionally provide skip and take parameters for pagination.`,
     { 
       spaceName: z.string().describe("The space name"),
-      skip: z.number().optional().describe("Number of items to skip for pagination"),
-      take: z.number().optional().describe("Number of items to take for pagination"),
+      skip: z.number().optional(),
+      take: z.number().optional(),
       projectId: z.string().optional().describe("Filter by specific project ID"),
       tags: z.string().optional().describe("Filter by tenant tags (comma-separated list)"),
       ids: z.array(z.string()).optional().describe("Filter by specific tenant IDs"),