designesy-org API

openapi: 3.1.0
info:
  title: designesy-org API
  version: '2026-11-05'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-05: 5 operation(s) read from 5 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; designesy-org has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 2
    documentation: 3
    pages-with-code: 4
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-05'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://www.designesy.org/specs
  - https://www.designesy.org/docs/mcp
  - https://www.designesy.org/open/handoff
  - https://www.designesy.org/specs.md
  - https://www.designesy.org/docs/mcp.md
paths:
  /api/mcp:
    post:
      operationId: post_api_mcp
      tags:
      - Api
      summary: POST /api/mcp
      x-source: https://www.designesy.org/docs/mcp
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiMcpRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl: curl -X POST https://www.designesy.org/api/mcp  -H "Content-Type: application/json"  -H "Accept: application/json, text/event-stream"  -d
          ''{"jsonrpc":"2.0","id":1,"method":"tools/list"}'' The response is one server-sent event carrying a JSON-RPC 2.0 result that lists all
          seventeen tools with their schemas. The Accept header must name both types; without it the endpoint answers HTTP 406. Relat'
  /api/score:
    post:
      operationId: post_api_score
      tags:
      - Api
      summary: POST /api/score
      x-source: https://www.designesy.org/specs
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiScoreRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST https://www.designesy.org/api/score  -H "Content-Type: application/json"  -d ''{"url":"https://www.designesy.org/","format":"canonical"}''
          Next Score a site Run the engine on any URL and read its findings in any of the four formats. /score The methodology How each finding
          is decided, and how the score is made from them. /methodology Benchmarks designesy beside hallmark and slop-eval, an'
  /contracts/design-system.json:
    get:
      operationId: get_contracts_design_system_json
      tags:
      - Contracts
      summary: Open handoff
      x-source: https://www.designesy.org/open/handoff
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetContractsDesignSystemJsonResponse'
      x-evidence:
        kind: documentation
  /kits/design-review.json:
    get:
      operationId: get_kits_design_review_json
      tags:
      - Kits
      summary: Open handoff
      x-source: https://www.designesy.org/open/handoff
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetKitsDesignReviewJsonResponse'
      x-evidence:
        kind: documentation
  /open:
    get:
      operationId: get_open
      tags:
      - Open
      summary: Open handoff
      x-source: https://www.designesy.org/open/handoff
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOpenResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiMcpRequest:
      type: object
      properties:
        jsonrpc:
          type: string
        id:
          type: integer
        method:
          type: string
    PostApiScoreRequest:
      type: object
      properties:
        url:
          type: string
        format:
          type: string
    GetContractsDesignSystemJsonResponse:
      type: object
      properties:
        rules:
          type: object
          description: Design system contract v0.4.7 rules.
    GetKitsDesignReviewJsonResponse:
      type: object
      properties:
        prompt:
          type: string
          description: Design Review kit prompt cargo.
    GetOpenResponse:
      type: object
      properties:
        catalog:
          type: object
          description: Human index listing all packages.
tags:
- name: Api
- name: Contracts
- name: Kits
- name: Open