{"openapi":"3.1.0","info":{"title":"Laravel Forge (BYOK) API","version":"0.1.0","description":"Laravel Forge (BYOK) lets an AI assistant read your own Laravel Forge data through the Laravel Forge API with a key you supply (API token). Read-only: 13 tools (list_organizations, list_servers, get_server, list_sites, list_server_sites, get_site, list_site_deployments, list_server_events, list_organization_events, list_server_monitors, list_server_databases, list_scheduled_jobs,...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-forge.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-forge/docs"},"termsOfService":"https://connectorbay.com/byok-forge/terms"},"servers":[{"url":"https://byok-forge.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-forge/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_organizations":{"post":{"operationId":"list_organizations","summary":"List the Laravel Forge organizations the token can access with name and slug. Use for \"Which Forge organizations do I be","description":"List the Laravel Forge organizations the token can access with name and slug. Use for \"Which Forge organizations do I belong to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Items per page (1 to 100, default 30).","title":"Page Size"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the 'meta.next_cursor' value of the previous answer. Leave out for the first page.","title":"Cursor"}},"title":"list_organizationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_servers":{"post":{"operationId":"list_servers","summary":"List the servers of a Forge organization with provider, region, size, PHP and database versions, IP address and connecti","description":"List the servers of a Forge organization with provider, region, size, PHP and database versions, IP address and connection status. Use for \"What servers do I have on Forge\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"Forge organization slug, as returned by list_organizations.","maxLength":100,"title":"Organization","type":"string"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only servers whose name matches this text.","title":"Name"},"region":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only servers in this provider region.","title":"Region"},"provider":{"anyOf":[{"maxLength":60,"type":"string"},{"type":"null"}],"default":null,"description":"Only servers from this provider.","title":"Provider"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Items per page (1 to 100, default 30).","title":"Page Size"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the 'meta.next_cursor' value of the previous answer. Leave out for the first page.","title":"Cursor"}},"required":["organization"],"title":"list_serversArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_server":{"post":{"operationId":"get_server","summary":"Get one Forge server by id: provider, region, size, versions, IP addresses, status and timezone. Use for \"Show details o","description":"Get one Forge server by id: provider, region, size, versions, IP addresses, status and timezone. Use for \"Show details of this Forge server\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"Forge organization slug, as returned by list_organizations.","maxLength":100,"title":"Organization","type":"string"},"server":{"description":"Forge server id, as returned by list_servers.","minimum":1,"title":"Server","type":"integer"}},"required":["organization","server"],"title":"get_serverArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_sites":{"post":{"operationId":"list_sites","summary":"List the sites of a Forge organization with domain, app type, deployment status, HTTPS and PHP version. Use for \"Which s","description":"List the sites of a Forge organization with domain, app type, deployment status, HTTPS and PHP version. Use for \"Which sites are hosted on my Forge account\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"Forge organization slug, as returned by list_organizations.","maxLength":100,"title":"Organization","type":"string"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only sites whose domain name matches this text.","title":"Name"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Items per page (1 to 100, default 30).","title":"Page Size"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the 'meta.next_cursor' value of the previous answer. Leave out for the first page.","title":"Cursor"}},"required":["organization"],"title":"list_sitesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_server_sites":{"post":{"operationId":"list_server_sites","summary":"List the sites on one Forge server with domain, app type, deployment status and HTTPS flag. Use for \"Which sites run on ","description":"List the sites on one Forge server with domain, app type, deployment status and HTTPS flag. Use for \"Which sites run on this Forge server\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"Forge organization slug, as returned by list_organizations.","maxLength":100,"title":"Organization","type":"string"},"server":{"description":"Forge server id, as returned by list_servers.","minimum":1,"title":"Server","type":"integer"},"name":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only sites whose domain name matches this text.","title":"Name"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Items per page (1 to 100, default 30).","title":"Page Size"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the 'meta.next_cursor' value of the previous answer. Leave out for the first page.","title":"Cursor"}},"required":["organization","server"],"title":"list_server_sitesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_site":{"post":{"operationId":"get_site","summary":"Get one Forge site by id: domain, app type, status, HTTPS, directories, PHP version and deployment status. Deployment sc","description":"Get one Forge site by id: domain, app type, status, HTTPS, directories, PHP version and deployment status. Deployment script and hook URL are not returned. Use for \"Show details of this Forge site\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"Forge organization slug, as returned by list_organizations.","maxLength":100,"title":"Organization","type":"string"},"site":{"description":"Forge site id, as returned by list_sites.","minimum":1,"title":"Site","type":"integer"}},"required":["organization","site"],"title":"get_siteArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_site_deployments":{"post":{"operationId":"list_site_deployments","summary":"List the deployments of a Forge site (newest first) with status, commit hash, author, message, branch and timings. Use f","description":"List the deployments of a Forge site (newest first) with status, commit hash, author, message, branch and timings. Use for \"Did the latest deployments of this Forge site succeed\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"Forge organization slug, as returned by list_organizations.","maxLength":100,"title":"Organization","type":"string"},"server":{"description":"Forge server id, as returned by list_servers.","minimum":1,"title":"Server","type":"integer"},"site":{"description":"Forge site id, as returned by list_sites.","minimum":1,"title":"Site","type":"integer"},"commit_message":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only deployments whose commit message matches this text.","title":"Commit Message"},"commit_author":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only deployments by this commit author.","title":"Commit Author"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Items per page (1 to 100, default 30).","title":"Page Size"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the 'meta.next_cursor' value of the previous answer. Leave out for the first page.","title":"Cursor"}},"required":["organization","server","site"],"title":"list_site_deploymentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_server_events":{"post":{"operationId":"list_server_events","summary":"List recent events on a Forge server (actions run on it) with description, who ran it and time. Use for \"What happened o","description":"List recent events on a Forge server (actions run on it) with description, who ran it and time. Use for \"What happened on this Forge server lately\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"Forge organization slug, as returned by list_organizations.","maxLength":100,"title":"Organization","type":"string"},"server":{"description":"Forge server id, as returned by list_servers.","minimum":1,"title":"Server","type":"integer"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Items per page (1 to 100, default 30).","title":"Page Size"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the 'meta.next_cursor' value of the previous answer. Leave out for the first page.","title":"Cursor"}},"required":["organization","server"],"title":"list_server_eventsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_organization_events":{"post":{"operationId":"list_organization_events","summary":"List recent events across a Forge organization with description, who ran it and time. Use for \"What has happened in my F","description":"List recent events across a Forge organization with description, who ran it and time. Use for \"What has happened in my Forge organization recently\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"Forge organization slug, as returned by list_organizations.","maxLength":100,"title":"Organization","type":"string"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Items per page (1 to 100, default 30).","title":"Page Size"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the 'meta.next_cursor' value of the previous answer. Leave out for the first page.","title":"Cursor"}},"required":["organization"],"title":"list_organization_eventsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_server_monitors":{"post":{"operationId":"list_server_monitors","summary":"List the monitors set on a Forge server (CPU, disk, memory and so on) with threshold, notify target and current state. U","description":"List the monitors set on a Forge server (CPU, disk, memory and so on) with threshold, notify target and current state. Use for \"What monitors are set on this Forge server\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"Forge organization slug, as returned by list_organizations.","maxLength":100,"title":"Organization","type":"string"},"server":{"description":"Forge server id, as returned by list_servers.","minimum":1,"title":"Server","type":"integer"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Items per page (1 to 100, default 30).","title":"Page Size"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the 'meta.next_cursor' value of the previous answer. Leave out for the first page.","title":"Cursor"}},"required":["organization","server"],"title":"list_server_monitorsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_server_databases":{"post":{"operationId":"list_server_databases","summary":"List the database schemas on a Forge server with name and status. Database users and passwords are not returned. Use for","description":"List the database schemas on a Forge server with name and status. Database users and passwords are not returned. Use for \"Which databases exist on this Forge server\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"Forge organization slug, as returned by list_organizations.","maxLength":100,"title":"Organization","type":"string"},"server":{"description":"Forge server id, as returned by list_servers.","minimum":1,"title":"Server","type":"integer"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Items per page (1 to 100, default 30).","title":"Page Size"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the 'meta.next_cursor' value of the previous answer. Leave out for the first page.","title":"Cursor"}},"required":["organization","server"],"title":"list_server_databasesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_scheduled_jobs":{"post":{"operationId":"list_scheduled_jobs","summary":"List the scheduled (cron) jobs on a Forge server with command, user, frequency and next run time. Use for \"What cron job","description":"List the scheduled (cron) jobs on a Forge server with command, user, frequency and next run time. Use for \"What cron jobs run on this Forge server\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"Forge organization slug, as returned by list_organizations.","maxLength":100,"title":"Organization","type":"string"},"server":{"description":"Forge server id, as returned by list_servers.","minimum":1,"title":"Server","type":"integer"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Items per page (1 to 100, default 30).","title":"Page Size"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the 'meta.next_cursor' value of the previous answer. Leave out for the first page.","title":"Cursor"}},"required":["organization","server"],"title":"list_scheduled_jobsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_firewall_rules":{"post":{"operationId":"list_firewall_rules","summary":"List the firewall rules of a Forge server with name, port, type, allowed IP address and status. Use for \"What firewall r","description":"List the firewall rules of a Forge server with name, port, type, allowed IP address and status. Use for \"What firewall rules does this Forge server have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"organization":{"description":"Forge organization slug, as returned by list_organizations.","maxLength":100,"title":"Organization","type":"string"},"server":{"description":"Forge server id, as returned by list_servers.","minimum":1,"title":"Server","type":"integer"},"page_size":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":30,"description":"Items per page (1 to 100, default 30).","title":"Page Size"},"cursor":{"anyOf":[{"maxLength":300,"type":"string"},{"type":"null"}],"default":null,"description":"Paging cursor: the 'meta.next_cursor' value of the previous answer. Leave out for the first page.","title":"Cursor"}},"required":["organization","server"],"title":"list_firewall_rulesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}