Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions .devcontainer/setup.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/instal
rmdir samples || true
mkdir samples

npm install
npm install -g ts-node
npm install --ignore-scripts
npm install -g ts-node --ignore-scripts
npm link
npm link opal-mcp
TS_CONFIG_CONTENT=$(cat <<EOL
Expand Down
6,107 changes: 5,171 additions & 936 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

25 changes: 23 additions & 2 deletions .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,41 @@ generation:
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: true
hoistGlobalSecurity: true
schemas:
allOfMergeStrategy: shallowMerge
requestBodyFieldName: ""
persistentEdits: {}
tests:
generateTests: true
generateNewTests: false
skipResponseBodyAssertions: false
typescript:
version: 0.7.0
version: 0.8.0
acceptHeaderEnum: true
additionalDependencies:
dependencies: {}
devDependencies: {}
peerDependencies: {}
additionalPackageJSON: {}
additionalScripts: {}
alwaysIncludeInboundAndOutbound: false
author: Speakeasy
baseErrorName: OpalMcpError
clientServerStatusCodesAsErrors: true
constFieldsAlwaysOptional: true
constFieldsAlwaysOptional: false
defaultErrorName: APIError
enableCustomCodeRegions: false
enableMCPServer: true
enableReactQuery: false
enumFormat: union
envVarPrefix: OPALMCP
exportZodModelNamespace: false
flattenGlobalSecurity: true
flatteningOrder: parameters-first
formStringArrayEncodeMode: encoded-string
forwardCompatibleEnumsByDefault: false
forwardCompatibleUnionsByDefault: "false"
generateExamples: true
imports:
option: openapi
Expand All @@ -51,13 +63,22 @@ typescript:
operations: models/operations
shared: models/components
webhooks: models/webhooks
inferUnionDiscriminators: true
inputModelSuffix: input
jsonpath: rfc9535
laxMode: strict
maxMethodParams: 0
methodArguments: require-security-and-request
modelPropertyCasing: camel
moduleFormat: dual
multipartArrayFormat: legacy
outputModelSuffix: output
packageName: opal-mcp
preApplyUnionDiscriminators: true
responseFormat: flat
sseFlatResponse: false
templateVersion: v2
unionStrategy: left-to-right
usageSDKInitImports: []
useIndexModules: true
zodVersion: v3
13 changes: 7 additions & 6 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,20 +1,21 @@
speakeasyVersion: 1.592.1
speakeasyVersion: 1.680.12
sources:
Opal API:
sourceNamespace: opal-api
sourceRevisionDigest: sha256:4a4bd5ee1457eec63bff5d655817c4b617e109ead6e9f1132644d856d9ff2209
sourceBlobDigest: sha256:353c5629289a76065ee83e77014e064454e57c4eb73955c10c6b018b9da09623
sourceRevisionDigest: sha256:7d40822b20f6d8e07146ae026e52e308177dffaea239425752f2224e5d08962a
sourceBlobDigest: sha256:c397fa21d82500efa5dbeb4ade6c9eaae3ef02ed51cde43c36fccbb71b0d6be2
tags:
- latest
- speakeasy-sdk-regen-1762733295
- "1.0"
targets:
opal-mcp:
source: Opal API
sourceNamespace: opal-api
sourceRevisionDigest: sha256:4a4bd5ee1457eec63bff5d655817c4b617e109ead6e9f1132644d856d9ff2209
sourceBlobDigest: sha256:353c5629289a76065ee83e77014e064454e57c4eb73955c10c6b018b9da09623
sourceRevisionDigest: sha256:7d40822b20f6d8e07146ae026e52e308177dffaea239425752f2224e5d08962a
sourceBlobDigest: sha256:c397fa21d82500efa5dbeb4ade6c9eaae3ef02ed51cde43c36fccbb71b0d6be2
codeSamplesNamespace: opal-api-typescript-code-samples
codeSamplesRevisionDigest: sha256:744f37e853a8eda4f41141b669cc712de2583e769c3ab8d2dae7ab10f54b390f
codeSamplesRevisionDigest: sha256:e054c2adc399387483c723a382d49abfeded8780ff1c234b0975466257ac299b
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
112 changes: 63 additions & 49 deletions README.md

Large diffs are not rendered by default.

12 changes: 11 additions & 1 deletion RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,14 @@ Based on:
### Generated
- [typescript v0.1.0] .
### Releases
- [NPM v0.1.0] https://www.npmjs.com/package/opal-mcp/v/0.1.0 - .
- [NPM v0.1.0] https://www.npmjs.com/package/opal-mcp/v/0.1.0 - .

## 2026-01-05 00:08:42
### Changes
Based on:
- OpenAPI Doc
- Speakeasy CLI 1.680.12 (2.788.15) https://github.com/speakeasy-api/speakeasy
### Generated
- [typescript v0.8.0] .
### Releases
- [NPM v0.8.0] https://www.npmjs.com/package/opal-mcp/v/0.8.0 - .
12 changes: 6 additions & 6 deletions RUNTIMES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:

* [Web Fetch API][web-fetch]
* [Web Streams API][web-streams] and in particular `ReadableStream`
* [Async iterables][async-iter] using `Symbol.asyncIterator`
- [Web Fetch API][web-fetch]
- [Web Streams API][web-streams] and in particular `ReadableStream`
- [Async iterables][async-iter] using `Symbol.asyncIterator`

[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
Expand All @@ -25,7 +25,7 @@ Runtime environments that are explicitly supported are:

The following `tsconfig.json` options are recommended for projects using this
SDK in order to get static type support for features like async iterables,
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
streams and `fetch`-related APIs ([`for await...of`][for-await-of],
[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
so on):

Expand All @@ -38,11 +38,11 @@ so on):
{
"compilerOptions": {
"target": "es2020", // or higher
"lib": ["es2020", "dom", "dom.iterable"],
"lib": ["es2020", "dom", "dom.iterable"]
}
}
```

While `target` can be set to older ECMAScript versions, it may result in extra,
unnecessary compatibility code being generated if you are not targeting old
runtimes.
runtimes.
19 changes: 19 additions & 0 deletions docs/models/components/anthropicworkspace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# AnthropicWorkspace

Remote info for Anthropic workspace.

## Example Usage

```typescript
import { AnthropicWorkspace } from "opal-mcp/models/components";

let value: AnthropicWorkspace = {
workspaceId: "ws-123456",
};
```

## Fields

| Field | Type | Required | Description | Example |
| ------------------------ | ------------------------ | ------------------------ | ------------------------ | ------------------------ |
| `workspaceId` | *string* | :heavy_check_mark: | The id of the workspace. | ws-123456 |
29 changes: 29 additions & 0 deletions docs/models/components/awsrdscluster.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# AwsRdsCluster

Remote info for AWS RDS cluster.

## Example Usage

```typescript
import { AwsRdsCluster } from "opal-mcp/models/components";

let value: AwsRdsCluster = {
clusterId: "demo-mysql-cluster",
region: "us-east-2",
resourceId: "cluster-AOO8V0XUCNU13XLZXQDQRSN0NQ",
accountId: "234234234234",
databaseName: "mydatabase",
engine: "POSTGRESQL",
};
```

## Fields

| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
| `clusterId` | *string* | :heavy_check_mark: | The clusterId of the RDS cluster. | demo-mysql-cluster |
| `region` | *string* | :heavy_check_mark: | The region of the RDS cluster. | us-east-2 |
| `resourceId` | *string* | :heavy_check_mark: | The resourceId of the RDS cluster. | cluster-AOO8V0XUCNU13XLZXQDQRSN0NQ |
| `accountId` | *string* | :heavy_check_mark: | The id of the AWS account. Required for AWS Organizations. | 234234234234 |
| `databaseName` | *string* | :heavy_check_mark: | The name of the database in the RDS cluster. This can be the value of the tag `opal:database-name` or the database name. | mydatabase |
| `engine` | [components.RDSEngineEnum](../../models/components/rdsengineenum.md) | :heavy_check_mark: | N/A | |
19 changes: 19 additions & 0 deletions docs/models/components/awsssogroup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# AwsSsoGroup

Remote info for AWS SSO group.

## Example Usage

```typescript
import { AwsSsoGroup } from "opal-mcp/models/components";

let value: AwsSsoGroup = {
groupId: "898931321",
};
```

## Fields

| Field | Type | Required | Description | Example |
| ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- | ---------------------------- |
| `groupId` | *string* | :heavy_check_mark: | The id of the AWS SSO group. | 898931321 |
19 changes: 19 additions & 0 deletions docs/models/components/azureenterpriseapp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# AzureEnterpriseApp

Remote info for Azure Enterprise App.

## Example Usage

```typescript
import { AzureEnterpriseApp } from "opal-mcp/models/components";

let value: AzureEnterpriseApp = {
resourceId: "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
};
```

## Fields

| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| `resourceId` | *string* | :heavy_check_mark: | The remote application identifier (service principal or application object ID). | aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee |
19 changes: 19 additions & 0 deletions docs/models/components/azureentraidrole.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# AzureEntraIdRole

Remote info for Azure Entra ID role.

## Example Usage

```typescript
import { AzureEntraIdRole } from "opal-mcp/models/components";

let value: AzureEntraIdRole = {
resourceId: "11111111-2222-3333-4444-555555555555",
};
```

## Fields

| Field | Type | Required | Description | Example |
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
| `resourceId` | *string* | :heavy_check_mark: | The remote role identifier from Entra (object ID). | 11111111-2222-3333-4444-555555555555 |
19 changes: 19 additions & 0 deletions docs/models/components/azuremanagementgroup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# AzureManagementGroup

Remote info for Azure management group.

## Example Usage

```typescript
import { AzureManagementGroup } from "opal-mcp/models/components";

let value: AzureManagementGroup = {
resourceId: "/providers/Microsoft.Management/managementGroups/my-mg",
};
```

## Fields

| Field | Type | Required | Description | Example |
| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ |
| `resourceId` | *string* | :heavy_check_mark: | The ARM resource ID of the management group. | /providers/Microsoft.Management/managementGroups/my-mg |
20 changes: 20 additions & 0 deletions docs/models/components/azureresourcegroup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# AzureResourceGroup

Remote info for Azure resource group.

## Example Usage

```typescript
import { AzureResourceGroup } from "opal-mcp/models/components";

let value: AzureResourceGroup = {
resourceId:
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg",
};
```

## Fields

| Field | Type | Required | Description | Example |
| ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ |
| `resourceId` | *string* | :heavy_check_mark: | The ARM resource ID of the resource group. | /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-rg |
20 changes: 20 additions & 0 deletions docs/models/components/azuresqldatabase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# AzureSqlDatabase

Remote info for Azure SQL database.

## Example Usage

```typescript
import { AzureSqlDatabase } from "opal-mcp/models/components";

let value: AzureSqlDatabase = {
resourceId:
"/subscriptions/0000/resourceGroups/rg/providers/Microsoft.Sql/servers/sqldev01/databases/db01",
};
```

## Fields

| Field | Type | Required | Description | Example |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `resourceId` | *string* | :heavy_check_mark: | The ARM resource ID of the SQL database. | /subscriptions/0000/resourceGroups/rg/providers/Microsoft.Sql/servers/sqldev01/databases/db01 |
Loading
Loading