get_tenant_by_id

Instructions

Implementation Reference

• src/tools/getTenantById.ts:21-51 (handler)

  The async handler function that creates an Octopus Deploy client, resolves the space ID, fetches the tenant resource by ID, formats key details into JSON, generates a public URL, and returns it as tool content.

  async ({spaceName, tenantId}) => {
    const configuration = getClientConfigurationFromEnvironment();
    const client = await Client.create(configuration);
    const spaceId = await resolveSpaceId(client, spaceName);
  
    const tenant = await client.get<TenantResource>("~/api/{spaceId}/tenant/{tenantId}", {spaceId, tenantId});
  
    return {
      content: [
        {
          type: "text",
          text: JSON.stringify({
            id: tenant.Id,
            name: tenant.Name,
            slug: tenant.Slug,
            description: tenant.Description,
            isDisabled: tenant.IsDisabled,
            projectEnvironments: tenant.ProjectEnvironments,
            tenantTags: tenant.TenantTags,
            clonedFromTenantId: tenant.ClonedFromTenantId,
            spaceId: tenant.SpaceId,
            publicUrl: getPublicUrl(`${configuration.instanceURL}/app#/{spaceId}/tenants/{tenantId}/overview`, {
              spaceId: tenant.SpaceId,
              tenantId: tenant.Id
            }),
            publicUrlInstruction: `You can view more details about this tenant in the Octopus Deploy web portal at the provided publicUrl.`
          }),
        },
      ],
    };
  }

• src/tools/getTenantById.ts:13-16 (schema)

  Input schema defined using Zod, specifying spaceName and tenantId as required string parameters with descriptions.

  {
    spaceName: z.string().describe("The space name"),
    tenantId: z.string().describe("The ID of the tenant to retrieve")
  },

• src/tools/getTenantById.ts:9-53 (registration)

  The registerGetTenantByIdTool function called to register the tool on the MCP server, specifying name, description, input schema, output metadata, and handler.

  export function registerGetTenantByIdTool(server: McpServer) {
    server.tool(
      "get_tenant_by_id",
      `Get details for a specific tenant by its ID, including the projects and environments the tenant is associated with. ${tenantsDescription}`,
      {
        spaceName: z.string().describe("The space name"),
        tenantId: z.string().describe("The ID of the tenant to retrieve")
      },
      {
        title: "Get tenant details by ID from Octopus Deploy",
        readOnlyHint: true,
      },
      async ({spaceName, tenantId}) => {
        const configuration = getClientConfigurationFromEnvironment();
        const client = await Client.create(configuration);
        const spaceId = await resolveSpaceId(client, spaceName);
  
        const tenant = await client.get<TenantResource>("~/api/{spaceId}/tenant/{tenantId}", {spaceId, tenantId});
  
        return {
          content: [
            {
              type: "text",
              text: JSON.stringify({
                id: tenant.Id,
                name: tenant.Name,
                slug: tenant.Slug,
                description: tenant.Description,
                isDisabled: tenant.IsDisabled,
                projectEnvironments: tenant.ProjectEnvironments,
                tenantTags: tenant.TenantTags,
                clonedFromTenantId: tenant.ClonedFromTenantId,
                spaceId: tenant.SpaceId,
                publicUrl: getPublicUrl(`${configuration.instanceURL}/app#/{spaceId}/tenants/{tenantId}/overview`, {
                  spaceId: tenant.SpaceId,
                  tenantId: tenant.Id
                }),
                publicUrlInstruction: `You can view more details about this tenant in the Octopus Deploy web portal at the provided publicUrl.`
              }),
            },
          ],
        };
      }
    );
  }

• src/tools/getTenantById.ts:55-59 (registration)

  Self-registration of the tool definition into the TOOL_REGISTRY, which is used by index.ts to conditionally register enabled tools.

  registerToolDefinition({
    toolName: "get_tenant_by_id",
    config: {toolset: "tenants", readOnly: true},
    registerFn: registerGetTenantByIdTool,
  });