Atlassian The Confluence Cloud REST API — Search

naftiko: 1.0.0-alpha2
info:
  label: Atlassian The Confluence Cloud REST API — Search
  description: 'Atlassian The Confluence Cloud REST API — Search. 2 operations. Lead operation: Atlassian Search Content.
    Self-contained Naftiko capability covering one Atlassian business surface.'
  tags:
  - Atlassian
  - Search
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ATLASSIAN_API_KEY: ATLASSIAN_API_KEY
capability:
  consumes:
  - type: http
    namespace: confluence-search
    baseUri: ''
    description: Atlassian The Confluence Cloud REST API — Search business capability. Self-contained, no shared references.
    resources:
    - name: wiki-rest-api-search
      path: /wiki/rest/api/search
      operations:
      - name: atlassiansearchbycql
        method: GET
        description: Atlassian Search Content
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cql
          in: query
          type: string
          description: The CQL query to be used for the search. See
          required: true
        - name: cqlcontext
          in: query
          type: string
          description: The space, content, and content status to execute the search
        - name: cursor
          in: query
          type: string
          description: Pointer to a set of search results, returned as part of the `next` or `prev` URL from the previous
            search call.
        - name: next
          in: query
          type: boolean
        - name: prev
          in: query
          type: boolean
        - name: limit
          in: query
          type: integer
          description: The maximum number of content objects to return per page.
        - name: start
          in: query
          type: integer
          description: The start point of the collection to return
        - name: includeArchivedSpaces
          in: query
          type: boolean
          description: Whether to include content from archived spaces in the results.
        - name: excludeCurrentSpaces
          in: query
          type: boolean
          description: Whether to exclude current spaces and only show archived spaces.
        - name: excerpt
          in: query
          type: string
          description: The excerpt strategy to apply to the result
        - name: sitePermissionTypeFilter
          in: query
          type: string
          description: Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator`
        - name: _
          in: query
          type: integer
        - name: expand
          in: query
          type: array
    - name: wiki-rest-api-search-user
      path: /wiki/rest/api/search/user
      operations:
      - name: atlassiansearchuser
        method: GET
        description: Atlassian Search Users
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cql
          in: query
          type: string
          description: The CQL query to be used for the search. See
          required: true
        - name: start
          in: query
          type: integer
          description: The starting index of the returned users.
        - name: limit
          in: query
          type: integer
          description: The maximum number of user objects to return per page.
        - name: expand
          in: query
          type: array
          description: A multi-value parameter indicating which properties of the user to expand.
        - name: sitePermissionTypeFilter
          in: query
          type: string
          description: Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator`
    authentication:
      type: bearer
      token: '{{env.ATLASSIAN_API_KEY}}'
  exposes:
  - type: rest
    namespace: confluence-search-rest
    port: 8080
    description: REST adapter for Atlassian The Confluence Cloud REST API — Search. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/wiki/rest/api/search
      name: wiki-rest-api-search
      description: REST surface for wiki-rest-api-search.
      operations:
      - method: GET
        name: atlassiansearchbycql
        description: Atlassian Search Content
        call: confluence-search.atlassiansearchbycql
        with:
          cql: rest.cql
          cqlcontext: rest.cqlcontext
          cursor: rest.cursor
          next: rest.next
          prev: rest.prev
          limit: rest.limit
          start: rest.start
          includeArchivedSpaces: rest.includeArchivedSpaces
          excludeCurrentSpaces: rest.excludeCurrentSpaces
          excerpt: rest.excerpt
          sitePermissionTypeFilter: rest.sitePermissionTypeFilter
          _: rest._
          expand: rest.expand
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/wiki/rest/api/search/user
      name: wiki-rest-api-search-user
      description: REST surface for wiki-rest-api-search-user.
      operations:
      - method: GET
        name: atlassiansearchuser
        description: Atlassian Search Users
        call: confluence-search.atlassiansearchuser
        with:
          cql: rest.cql
          start: rest.start
          limit: rest.limit
          expand: rest.expand
          sitePermissionTypeFilter: rest.sitePermissionTypeFilter
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: confluence-search-mcp
    port: 9090
    transport: http
    description: MCP adapter for Atlassian The Confluence Cloud REST API — Search. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: atlassian-search-content
      description: Atlassian Search Content
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-search.atlassiansearchbycql
      with:
        cql: tools.cql
        cqlcontext: tools.cqlcontext
        cursor: tools.cursor
        next: tools.next
        prev: tools.prev
        limit: tools.limit
        start: tools.start
        includeArchivedSpaces: tools.includeArchivedSpaces
        excludeCurrentSpaces: tools.excludeCurrentSpaces
        excerpt: tools.excerpt
        sitePermissionTypeFilter: tools.sitePermissionTypeFilter
        _: tools._
        expand: tools.expand
      outputParameters:
      - type: object
        mapping: $.
    - name: atlassian-search-users
      description: Atlassian Search Users
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: confluence-search.atlassiansearchuser
      with:
        cql: tools.cql
        start: tools.start
        limit: tools.limit
        expand: tools.expand
        sitePermissionTypeFilter: tools.sitePermissionTypeFilter
      outputParameters:
      - type: object
        mapping: $.