openapi: 3.1.0
info:
  title: succ.ai public surface
  version: 1.1.0
  description: |
    Public, read-only endpoints exposed by succ.ai. These help search engines and AI agents discover
    the site, sitemap, robots rules, LLM hints, and the MCP manifest that describes the 14 consolidated
    succ MCP tools. There are no mutating endpoints.
servers:
  - url: https://succ.ai
paths:
  /api/manifest:
    get:
      summary: MCP discovery manifest
      operationId: getManifest
      tags: [agents]
      responses:
        '200':
          description: Claude/ChatGPT-friendly manifest describing MCP tools
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Manifest'
              examples:
                default:
                  $ref: '#/components/examples/ManifestExample'
  /robots.txt:
    get:
      summary: Robots rules
      operationId: getRobots
      tags: [seo]
      responses:
        '200':
          description: robots.txt allowing crawl and pointing to sitemap
          content:
            text/plain: {}
  /sitemap.xml:
    get:
      summary: Sitemap
      operationId: getSitemap
      tags: [seo]
      responses:
        '200':
          description: XML sitemap of public pages
          content:
            application/xml: {}
  /.well-known/llms.txt:
    get:
      summary: LLM crawl hints
      operationId: getLlms
      tags: [agents]
      responses:
        '200':
          description: Markdown overview of succ for LLMs, with tool list and links
          content:
            text/plain: {}
  /.well-known/ai.txt:
    get:
      summary: AI crawl hints
      operationId: getAiTxt
      tags: [agents]
      responses:
        '200':
          description: AI agent discovery info with manifest and spec links
          content:
            text/plain: {}
components:
  schemas:
    Manifest:
      type: object
      required: [schema_version, name_for_human, name_for_model, description_for_model, api]
      properties:
        schema_version:
          type: string
          example: v1
        name_for_human:
          type: string
          example: succ MCP surface
        name_for_model:
          type: string
          example: succ_mcp
        description_for_human:
          type: string
        description_for_model:
          type: string
          description: One-line summary of consolidated MCP tools and actions.
        contact_email:
          type: string
          format: email
        legal_info_url:
          type: string
          format: uri
        api:
          type: object
          required: [type, url, is_user_authenticated]
          properties:
            type:
              type: string
              enum: [openapi]
            url:
              type: string
              format: uri
              description: Points back to this openapi.yaml
            is_user_authenticated:
              type: boolean
        usage:
          type: object
          properties:
            terms_url:
              type: string
              format: uri
            privacy_policy_url:
              type: string
              format: uri
        assets:
          type: object
          properties:
            icon_url:
              type: string
              format: uri
  examples:
    ManifestExample:
      value:
        schema_version: v1
        name_for_human: succ MCP surface
        name_for_model: succ_mcp
        description_for_human: Open source semantic memory with 14 consolidated MCP tools for Claude Code.
        description_for_model: succ provides 14 MCP tools with action parameters: succ_index (doc|code|analyze|refresh|symbols), succ_search, succ_search_code, succ_remember, succ_recall, succ_forget, succ_dead_end, succ_link (create|delete|show|graph|auto|enrich|proximity|communities|centrality|export|cleanup|explore), succ_status (overview|stats|score), succ_config (show|set|checkpoint_create|checkpoint_list), succ_debug (create|hypothesis|instrument|result|resolve|abandon|status|list), succ_prd (generate|list|status|run|export), succ_web (quick|search|deep|history), succ_fetch.
        contact_email: hello@succ.ai
        legal_info_url: https://succ.ai
        api:
          type: openapi
          url: https://succ.ai/openapi.yaml
          is_user_authenticated: false
        usage:
          terms_url: https://succ.ai
          privacy_policy_url: https://succ.ai
        assets:
          icon_url: https://succ.ai/icon.svg