ReadMe API — Search

naftiko: 1.0.0-alpha2
info:
  label: ReadMe API — Search
  description: 'ReadMe API — Search. 1 operations. Lead operation: Search knowledge base. Self-contained Naftiko capability
    covering one Readme business surface.'
  tags:
  - Readme
  - Search
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    README_API_KEY: README_API_KEY
capability:
  consumes:
  - type: http
    namespace: readme-search
    baseUri: https://api.readme.com/v2
    description: ReadMe API — Search business capability. Self-contained, no shared references.
    resources:
    - name: search
      path: /search
      operations:
      - name: get
        method: GET
        description: Search knowledge base
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: search
          in: query
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.README_API_KEY}}'
  exposes:
  - type: rest
    namespace: readme-search-rest
    port: 8080
    description: REST adapter for ReadMe API — Search. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/search
      name: search
      description: REST surface for search.
      operations:
      - method: GET
        name: get
        description: Search knowledge base
        call: readme-search.get
        with:
          search: rest.search
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: readme-search-mcp
    port: 9090
    transport: http
    description: MCP adapter for ReadMe API — Search. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: search-knowledge-base
      description: Search knowledge base
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: readme-search.get
      with:
        search: tools.search
      outputParameters:
      - type: object
        mapping: $.