@probelabs/visor 0.1.132 → 0.1.137

package/dist/examples/api-tools-ai-example.yaml

@@ -0,0 +1,63 @@
+version: "1.0"
+
+# Reuse the API bundle from a separate tools file and expose it to AI.
+extends: ./api-tools-library.yaml
+
+checks:
+  api-assistant:
+    type: ai
+    prompt: |
+      You have access to users-api MCP tools generated from OpenAPI.
+      Explain how to call getUser and which required fields are needed.
+    ai_custom_tools:
+      - users-api
+    ai:
+      provider: anthropic
+      model: claude-3-5-sonnet-20241022
+    on:
+      - manual
+
+  api-tool-whitelist-check:
+    type: mcp
+    transport: custom
+    method: createUser
+    methodArgs:
+      requestBody:
+        name: Alice
+    on:
+      - issue_comment
+
+tests:
+  defaults:
+    strict: true
+    ai_provider: mock
+  cases:
+    - name: api-ai-example-loads-reusable-api-bundle
+      description: AI step resolves users-api from external library file
+      event: manual
+      fixture: local.minimal
+      mocks:
+        api-assistant:
+          text: getUser requires the id path parameter.
+      expect:
+        calls:
+          - step: api-assistant
+            exactly: 1
+        prompts:
+          - step: api-assistant
+            contains:
+              - users-api
+              - getUser
+
+    - name: api-ai-example-keeps-whitelist-enforcement
+      description: API bundle whitelist still applies when reused in AI config
+      event: issue_comment
+      fixture: gh.issue_comment.standard
+      expect:
+        calls:
+          - step: api-tool-whitelist-check
+            exactly: 1
+        outputs:
+          - step: api-tool-whitelist-check
+            path: issues[0].message
+            matches: "(?i)Custom tool not found: createUser"

package/dist/examples/api-tools-inline-overlay-example.yaml

@@ -0,0 +1,126 @@
+version: "1.0"
+
+tools:
+  users-api-file-overlay:
+    type: api
+    name: users-api-file-overlay
+    description: File-based OpenAPI and overlay definitions
+    spec: ./openapi/users-api.json
+    headers:
+      Authorization: "Bearer ${USERS_API_BEARER_TOKEN}"
+      X-Tenant-Id: "${USERS_API_TENANT_ID}"
+    overlays:
+      - ./openapi/users-overlay-rename.yaml
+    whitelist:
+      - getUserFromFileOverlay
+
+  users-api-inline-mixed-overlay:
+    type: api
+    name: users-api-inline-mixed-overlay
+    description: Inline OpenAPI plus mixed file + inline overlays
+    headers:
+      Authorization: "Bearer ${PROFILES_API_BEARER_TOKEN}"
+      X-Tenant-Id: "${USERS_API_TENANT_ID}"
+    spec:
+      openapi: "3.0.0"
+      info:
+        title: Profiles API Inline Example
+        version: "1.0.0"
+      servers:
+        - url: https://api.example.invalid
+      paths:
+        /profiles/{id}:
+          get:
+            operationId: getProfile
+            summary: Get profile by id
+            parameters:
+              - name: id
+                in: path
+                required: true
+                schema:
+                  type: string
+            responses:
+              "200":
+                description: Profile payload
+                content:
+                  application/json:
+                    schema:
+                      type: object
+                      properties:
+                        id:
+                          type: string
+                        handle:
+                          type: string
+    overlays:
+      - ./openapi/profiles-overlay-rename.yaml
+      - actions:
+          - target: "$.paths['/profiles/{id}'].get.operationId"
+            update: getProfileFromInlineOverlay
+
+checks:
+  api-file-overlay-required-input:
+    type: mcp
+    transport: custom
+    method: getUserFromFileOverlay
+    methodArgs: {}
+    on:
+      - manual
+
+  api-inline-overlay-required-input:
+    type: mcp
+    transport: custom
+    method: getProfileFromInlineOverlay
+    methodArgs: {}
+    on:
+      - issue_comment
+
+  api-inline-overlay-original-name-blocked:
+    type: mcp
+    transport: custom
+    method: getProfile
+    methodArgs: {}
+    on:
+      - pr_opened
+
+tests:
+  defaults:
+    strict: true
+  cases:
+    - name: api-inline-example-file-overlay-tool-is-generated
+      description: File-based OpenAPI + overlay renames getUser to getUserFromFileOverlay
+      event: manual
+      fixture: local.minimal
+      expect:
+        calls:
+          - step: api-file-overlay-required-input
+            exactly: 1
+        outputs:
+          - step: api-file-overlay-required-input
+            path: issues[0].message
+            matches: "(?i)required property 'id'"
+
+    - name: api-inline-example-inline-spec-and-mixed-overlays-work
+      description: Inline OpenAPI supports file and inline overlays, applied in order
+      event: issue_comment
+      fixture: gh.issue_comment.standard
+      expect:
+        calls:
+          - step: api-inline-overlay-required-input
+            exactly: 1
+        outputs:
+          - step: api-inline-overlay-required-input
+            path: issues[0].message
+            matches: "(?i)required property 'id'"
+
+    - name: api-inline-example-original-operation-id-is-not-exposed
+      description: Final overlay output hides the original getProfile method name
+      event: pr_opened
+      fixture: gh.pr_open.minimal
+      expect:
+        calls:
+          - step: api-inline-overlay-original-name-blocked
+            exactly: 1
+        outputs:
+          - step: api-inline-overlay-original-name-blocked
+            path: issues[0].message
+            matches: "(?i)Custom tool not found: getProfile"

package/dist/examples/api-tools-library.yaml

@@ -0,0 +1,18 @@
+version: "1.0"
+
+# Reusable OpenAPI API bundle.
+# Import this file via `extends:` from other configs to expose generated MCP tools.
+tools:
+  users-api:
+    type: api
+    name: users-api
+    description: Reusable users API tool bundle generated from OpenAPI
+    spec: ./openapi/users-api.json
+    headers:
+      Authorization: "Bearer ${USERS_API_BEARER_TOKEN}"
+      X-Tenant-Id: "${USERS_API_TENANT_ID}"
+    whitelist:
+      - "get*"
+
+# Library-only file: no executable steps here.
+steps: {}

package/dist/examples/api-tools-mcp-example.yaml

@@ -0,0 +1,55 @@
+version: "1.0"
+
+# Reuse API bundle definition from a separate file.
+extends: ./api-tools-library.yaml
+
+checks:
+  # Generated operation tool validates required OpenAPI args before any HTTP call.
+  api-tool-missing-required-input:
+    type: mcp
+    transport: custom
+    method: getUser
+    methodArgs: {}
+    on:
+      - manual
+
+  # Whitelist in api-tools-library.yaml allows get* only, so createUser is blocked.
+  api-tool-whitelist-enforced:
+    type: mcp
+    transport: custom
+    method: createUser
+    methodArgs:
+      requestBody:
+        name: Alice
+    on:
+      - issue_comment
+
+tests:
+  defaults:
+    strict: true
+  cases:
+    - name: api-example-validates-generated-operation-input
+      description: getUser requires path parameter id from the OpenAPI schema
+      event: manual
+      fixture: local.minimal
+      expect:
+        calls:
+          - step: api-tool-missing-required-input
+            exactly: 1
+        outputs:
+          - step: api-tool-missing-required-input
+            path: issues[0].message
+            matches: "(?i)required property 'id'"
+
+    - name: api-example-enforces-operation-whitelist
+      description: createUser is not exposed because api bundle whitelist is get*
+      event: issue_comment
+      fixture: gh.issue_comment.standard
+      expect:
+        calls:
+          - step: api-tool-whitelist-enforced
+            exactly: 1
+        outputs:
+          - step: api-tool-whitelist-enforced
+            path: issues[0].message
+            matches: "(?i)Custom tool not found: createUser"

package/dist/examples/openapi/profiles-overlay-rename.yaml

@@ -0,0 +1,3 @@
+actions:
+  - target: "$.paths['/profiles/{id}'].get.operationId"
+    update: getProfileFromFileOverlay

package/dist/examples/openapi/users-api.json

@@ -0,0 +1,91 @@
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "Users API Example Spec",
+    "version": "1.0.0"
+  },
+  "servers": [
+    {
+      "url": "https://api.example.invalid"
+    }
+  ],
+  "paths": {
+    "/users/{id}": {
+      "get": {
+        "operationId": "getUser",
+        "summary": "Get user by id",
+        "parameters": [
+          {
+            "name": "id",
+            "in": "path",
+            "required": true,
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "User payload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string"
+                    },
+                    "name": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/users": {
+      "post": {
+        "operationId": "createUser",
+        "summary": "Create user",
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "name"
+                ]
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Creation payload",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "created": {
+                      "type": "boolean"
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  }
+}

package/dist/examples/openapi/users-overlay-rename.yaml

@@ -0,0 +1,3 @@
+actions:
+  - target: "$.paths['/users/{id}'].get.operationId"
+    update: getUserFromFileOverlay