CMiC Construction ERP API — Projects

naftiko: 1.0.0-alpha2
info:
  label: CMiC Construction ERP API — Projects
  description: 'CMiC Construction ERP API — Projects. 4 operations. Lead operation: List construction projects. Self-contained
    Naftiko capability covering one Cmic business surface.'
  tags:
  - Cmic
  - Projects
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CMIC_API_KEY: CMIC_API_KEY
capability:
  consumes:
  - type: http
    namespace: construction-erp-projects
    baseUri: https://api.cmic.ca/rest
    description: CMiC Construction ERP API — Projects business capability. Self-contained, no shared references.
    resources:
    - name: pm-rest-api-v1-PMproject
      path: /pm-rest-api/v1/PMproject
      operations:
      - name: listprojects
        method: GET
        description: List construction projects
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: companyCode
          in: query
          type: string
          description: Filter by company code
        - name: projectStatus
          in: query
          type: string
          description: Filter by project status
        - name: limit
          in: query
          type: integer
        - name: offset
          in: query
          type: integer
      - name: createproject
        method: POST
        description: Create a new construction project
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: pm-rest-api-v1-PMproject-projectId
      path: /pm-rest-api/v1/PMproject/{projectId}
      operations:
      - name: getproject
        method: GET
        description: Get project details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: Unique project identifier
          required: true
      - name: updateproject
        method: PUT
        description: Update project details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.CMIC_API_KEY}}'
  exposes:
  - type: rest
    namespace: construction-erp-projects-rest
    port: 8080
    description: REST adapter for CMiC Construction ERP API — Projects. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/pm-rest-api/v1/pmproject
      name: pm-rest-api-v1-pmproject
      description: REST surface for pm-rest-api-v1-PMproject.
      operations:
      - method: GET
        name: listprojects
        description: List construction projects
        call: construction-erp-projects.listprojects
        with:
          companyCode: rest.companyCode
          projectStatus: rest.projectStatus
          limit: rest.limit
          offset: rest.offset
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createproject
        description: Create a new construction project
        call: construction-erp-projects.createproject
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/pm-rest-api/v1/pmproject/{projectid}
      name: pm-rest-api-v1-pmproject-projectid
      description: REST surface for pm-rest-api-v1-PMproject-projectId.
      operations:
      - method: GET
        name: getproject
        description: Get project details
        call: construction-erp-projects.getproject
        with:
          projectId: rest.projectId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateproject
        description: Update project details
        call: construction-erp-projects.updateproject
        with:
          projectId: rest.projectId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: construction-erp-projects-mcp
    port: 9090
    transport: http
    description: MCP adapter for CMiC Construction ERP API — Projects. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-construction-projects
      description: List construction projects
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: construction-erp-projects.listprojects
      with:
        companyCode: tools.companyCode
        projectStatus: tools.projectStatus
        limit: tools.limit
        offset: tools.offset
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-construction-project
      description: Create a new construction project
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: construction-erp-projects.createproject
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-project-details
      description: Get project details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: construction-erp-projects.getproject
      with:
        projectId: tools.projectId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-project-details
      description: Update project details
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: construction-erp-projects.updateproject
      with:
        projectId: tools.projectId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.