@aashari/mcp-server-atlassian-confluence/dist/services/vendor.atlassian.pages.service.d.ts

Node.js/TypeScript MCP server for Atlassian Confluence. Provides tools enabling AI systems (LLMs) to list/get spaces & pages (content formatted as Markdown) and search via CQL. Connects AI seamlessly to Confluence knowledge bases using the standard MCP in

import { PageDetailedSchema, PagesResponseSchema, ListPagesParams, GetPageByIdParams } from './vendor.atlassian.pages.types.js';
import { z } from 'zod';
/**
 * @namespace VendorAtlassianPagesService
 * @description Service for interacting with Confluence Pages API.
 * Provides methods for listing pages and retrieving page details.
 * All methods require valid Atlassian credentials configured in the environment.
 */
/**
 * List Confluence pages with optional filtering and pagination
 *
 * Retrieves a list of pages from Confluence with support for various filters
 * and pagination options. Pages can be filtered by space, status, parent, etc.
 *
 * @async
 * @memberof VendorAtlassianPagesService
 * @param {ListPagesParams} params - Optional parameters to customize the request
 * @returns {Promise<PagesResponseType>} Promise containing the pages response with results and pagination info
 * @throws {Error} If Atlassian credentials are missing or API request fails
 * @example
 * // List pages from a specific space
 * const response = await list({
 *   spaceId: ['123'],
 *   status: ['current'],
 *   limit: 25
 * });
 */
declare function list(params: ListPagesParams): Promise<z.infer<typeof PagesResponseSchema>>;
/**
 * Get detailed information about a specific Confluence page
 *
 * Retrieves comprehensive details about a single page, including content,
 * metadata, and optional components like labels, properties, and versions.
 *
 * @async
 * @memberof VendorAtlassianPagesService
 * @param {string} id - The ID of the page to retrieve
 * @param {GetPageByIdParams} params - Optional parameters to customize the response
 * @returns {Promise<PageDetailedSchemaType>} Promise containing the detailed page information
 * @throws {Error} If Atlassian credentials are missing or API request fails
 * @example
 * // Get page details with labels and versions
 * const page = await get('123', {
 *   bodyFormat: 'storage',
 *   includeLabels: true,
 *   includeVersions: true
 * });
 */
declare function get(pageId: string, params?: GetPageByIdParams): Promise<z.infer<typeof PageDetailedSchema>>;
declare const _default: {
    list: typeof list;
    get: typeof get;
};
export default _default;