@workos/mcp-docs-server 0.1.0

package/.docs/organized/docs/reference/vault/object/create.mdx

@@ -0,0 +1,62 @@
+---
+reference:
+  curl:
+    - key: create_object
+      id: create_object
+      url: /reference/vault/object/create
+      title: /vault/v1/kv
+      type: POST
+      parameters:
+        - (object.name)
+        - (object.value)
+        - key: key_context
+          type: object
+          description: (object_metadata.context)
+      returns:
+        - (object.metadata)
+  js:
+    - key: createObject
+      id: create_object
+      url: /reference/vault/object/create
+      title: vault.createObject()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - (Object.name)
+            - (Object.value)
+            - key: context
+              type: object
+              description: (object_metadata.context)
+      returns:
+        - (Object.metadata)
+  go:
+    - key: CreateObject
+      id: create_object
+      url: /reference/vault/object/create
+      title: vault.CreateObject()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: vault.CreateObjectOpts
+          expanded: true
+          properties:
+            - (Object.Name)
+            - (Object.Value)
+            - key: KeyContext
+              type: vault.KeyContext
+              description: (object_metadata.context)
+      returns:
+        - (Object.Metadata)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/object/create.mdx
+---
+
+## Create an object
+
+Create a new object, encrypted with the key(s) matching the provided key context.
+
+<CodeBlock referenceId="create_object">
+  <CodeBlockTab title="Request" file="create-object-request" />
+  <CodeBlockTab title="Response" file="create-object-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/vault/object/delete.mdx

@@ -0,0 +1,75 @@
+---
+reference:
+  curl:
+    - key: delete_object
+      id: delete_object
+      url: /reference/vault/object/delete
+      title: '/vault/v1/kv/:id'
+      type: DELETE
+      parameters:
+        - (object.id)
+        - key: version_check
+          optional: true
+          type: string
+          description: (object_metadata.version_check)
+      returns:
+        - key: success
+          type: boolean
+          description: Flag indicating whether the object was successfully deleted.
+        - (object.name)
+  js:
+    - key: deleteObject
+      id: delete_object
+      url: /reference/vault/object/delete
+      title: vault.deleteObject()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - (Object.id)
+            - key: version_check
+              optional: true
+              type: string
+              description: (object_metadata.version_check)
+      returns:
+        - key: success
+          type: boolean
+          description: Flag indicating whether the object was successfully deleted.
+        - (Object.name)
+  go:
+    - key: DeleteObject
+      id: delete_object
+      url: /reference/vault/object/delete
+      title: vault.DeleteObject()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: vault.DeleteObjectOpts
+          expanded: true
+          properties:
+            - (Object.Id)
+            - key: VersionCheck
+              optional: true
+              type: string
+              description: (object_metadata.version_check)
+      returns:
+        - key: response
+          type: vault.DeleteObjectResponse
+          expanded: true
+          properties:
+            - key: Success
+              type: boolean
+              description: Flag indicating whether the object was successfully deleted.
+            - (Object.Name)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/object/delete.mdx
+---
+
+## Delete an object
+
+Permanently delete an object.
+
+<CodeBlock referenceId="delete_object">
+  <CodeBlockTab title="Request" file="delete-object-request" />
+  <CodeBlockTab title="Response" file="delete-object-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/vault/object/get.mdx

@@ -0,0 +1,50 @@
+---
+reference:
+  curl:
+    - key: get_object
+      id: get_object
+      url: /reference/vault/object/get
+      title: '/vault/v1/kv/:id'
+      type: GET
+      parameters:
+        - (object.id)
+      returns:
+        - (object)
+  js:
+    - key: readObject
+      id: get_object
+      url: /reference/vault/object/get
+      title: vault.readObject()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - (Object.id)
+      returns:
+        - (Object)
+  go:
+    - key: ReadObject
+      id: get_object
+      url: /reference/vault/object/get
+      title: vault.ReadObject()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: vault.ReadObjectOpts
+          expanded: true
+          properties:
+            - (Object.Id)
+      returns:
+        - (Object)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/object/get.mdx
+---
+
+## Get an object
+
+Get an existing object. The stored value will be decrypted and returned.
+
+<CodeBlock referenceId="get_object">
+  <CodeBlockTab title="Request" file="get-object-request" />
+  <CodeBlockTab title="Response" file="get-object-full-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/vault/object/index.mdx

@@ -0,0 +1,174 @@
+---
+descriptions:
+  object:
+    self: 'The Vault [Object](/reference/vault/object).'
+    id: Unique string ID of the object.
+    name: 'Unique name of the object, used as the KV store key.'
+    value: Plaintext data that will be stored in an encrypted format.
+  object_metadata:
+    self: 'The Vault Object [Metadata](/reference/vault/object/metadata).'
+    context: Map of values used to determine the encryption key used.
+    environment_id: ID of the WorkOS environment where the object was created.
+    key_id: ID of the key used to encrypt the object.
+    updated_at: ISO 8601 timestamp of the last modification to the object.
+    updated_by:
+      id: ID of the user or API key that last wrote to the object.
+      name: >-
+        Name of the user or [API key](/reference/api-keys) that last wrote to
+        the object.
+    version_id: ID of the specific version of the object.
+    version_check: >-
+      ID of the expected version of the object. When this is set, the operation
+      will fail if the current version is different than the one provided.
+reference:
+  curl:
+    - url: /reference/vault/object
+      key: object
+      id: object
+      title: object
+      properties:
+        - key: id
+          type: string
+          description: (object.id)
+        - key: name
+          type: string
+          description: (object.name)
+        - key: value
+          type: string
+          description: (object.value)
+        - key: metadata
+          type: object
+          expanded: true
+          properties:
+            - key: id
+              type: string
+              description: (object.id)
+            - key: environment_id
+              type: string
+              description: (object_metadata.environment_id)
+            - key: context
+              type: object
+              description: (object_metadata.context)
+            - key: key_id
+              type: string
+              description: (object_metadata.key_id)
+            - key: updated_at
+              type: string
+              description: (object_metadata.updated_at)
+            - key: updated_by
+              type: object
+              expanded: true
+              properties:
+                - key: id
+                  type: string
+                  description: (object_metadata.updated_by.id)
+                - key: name
+                  type: string
+                  description: (object_metadata.updated_by.name)
+            - key: version_id
+              type: string
+              description: (object_metadata.version_id)
+  js:
+    - url: /reference/vault/object
+      key: Object
+      id: object
+      title: interface Object
+      properties:
+        - key: id
+          type: string
+          description: (object.id)
+        - key: name
+          type: string
+          description: (object.name)
+        - key: value
+          type: string
+          description: (object.value)
+        - key: metadata
+          type: object
+          expanded: true
+          properties:
+            - key: id
+              type: string
+              description: (object.id)
+            - key: environmentId
+              type: string
+              description: (object_metadata.environment_id)
+            - key: context
+              type: object
+              description: (object_metadata.context)
+            - key: keyId
+              type: string
+              description: (object_metadata.key_id)
+            - key: updatedAt
+              type: string
+              description: (object_metadata.updated_at)
+            - key: updatedBy
+              type: object
+              expanded: true
+              properties:
+                - key: id
+                  type: string
+                  description: (object_metadata.updated_by.id)
+                - key: name
+                  type: string
+                  description: (object_metadata.updated_by.name)
+            - key: versionId
+              type: string
+              description: (object_metadata.version_id)
+  go:
+    - url: /reference/vault/object
+      key: Object
+      id: object
+      title: vault.Object
+      properties:
+        - key: Id
+          type: string
+          description: (object.id)
+        - key: Name
+          type: string
+          description: (object.name)
+        - key: Value
+          type: string
+          description: (object.value)
+        - key: Metadata
+          type: vault.ObjectMetadata
+          expanded: true
+          properties:
+            - key: Id
+              type: string
+              description: (object.id)
+            - key: EnvironmentId
+              type: string
+              description: (object_metadata.environment_id)
+            - key: Context
+              type: vault.KeyContext
+              description: (object_metadata.context)
+            - key: KeyId
+              type: string
+              description: (object_metadata.key_id)
+            - key: UpdatedAt
+              type: time.Time
+              description: (object_metadata.updated_at)
+            - key: UpdatedBy
+              type: struct
+              expanded: true
+              properties:
+                - key: Id
+                  type: string
+                  description: (object_metadata.updated_by.id)
+                - key: Name
+                  type: string
+                  description: (object_metadata.updated_by.name)
+            - key: VersionId
+              type: string
+              description: (object_metadata.version_id)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/object/index.mdx
+---
+
+---
+
+# Encrypted Object
+
+Represents an encrypted object stored by Vault.
+
+<CodeBlock title="Object" referenceId="object" file="object" />

package/.docs/organized/docs/reference/vault/object/list.mdx

@@ -0,0 +1,105 @@
+---
+reference:
+  curl:
+    - key: list_objects
+      id: list_objects
+      url: /reference/vault/object/list
+      title: /vault/v1/kv
+      type: GET
+      parameters:
+        - (limit)
+        - (before)
+        - (after)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              properties:
+                - (object.id)
+                - (object.name)
+                - key: updated_at
+                  type: string
+                  description: (object_metadata.updated_at)
+            - key: list_metadata
+              type: object
+              properties:
+                - (after)
+                - (before)
+  js:
+    - key: listObjects
+      id: list_objects
+      url: /reference/vault/object/list
+      title: vault.listObjects()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          optional: true
+          properties:
+            - (limit)
+            - (before)
+            - (after)
+      returns:
+        - key: anonymous
+          type: object
+          unwrap: true
+          properties:
+            - key: data
+              type: array
+              properties:
+                - (Object.id)
+                - (Object.name)
+                - key: updatedAt
+                  type: string
+                  description: (object_metadata.updated_at)
+            - key: listMetadata
+              type: object
+              properties:
+                - (after)
+                - (before)
+  go:
+    - key: ListObjects
+      id: list_objects
+      url: /reference/vault/object/list
+      title: vault.ListObjects()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: vault.ListObjectsOpts
+          expanded: true
+          properties:
+            - (Limit)
+            - (Before)
+            - (After)
+      returns:
+        - key: listResponse
+          type: vault.ListObjectVersionsResponse
+          unwrap: true
+          properties:
+            - key: data
+              type: 'vault.ObjectDigest[]'
+              properties:
+                - (Object.Id)
+                - (Object.Name)
+                - key: UpdatedAt
+                  type: time.Time
+                  description: (object_metadata.updated_at)
+            - key: ListMetadata
+              type: ListMetadata
+              properties:
+                - (Before)
+                - (After)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/object/list.mdx
+---
+
+## List objects
+
+Get list of object names stored in Vault.
+
+<CodeBlock referenceId="list_objects">
+  <CodeBlockTab title="Request" file="list-objects-request" />
+  <CodeBlockTab title="Response" file="list-objects-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/vault/object/metadata.mdx

@@ -0,0 +1,52 @@
+---
+reference:
+  curl:
+    - key: describe_object
+      id: describe_object
+      url: /reference/vault/object/metadata
+      title: '/vault/v1/kv/:id/metadata'
+      type: GET
+      parameters:
+        - (object.id)
+      returns:
+        - (object.id)
+        - (object.name)
+        - (object.metadata)
+  js:
+    - key: describeObject
+      id: describe_object
+      url: /reference/vault/object/metadata
+      title: vault.describeObject()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - (Object.id)
+      returns:
+        - (Object)
+  go:
+    - key: DescribeObject
+      id: describe_object
+      url: /reference/vault/object/metadata
+      title: vault.DescribeObject()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: vault.ReadObjectOpts
+          expanded: true
+          properties:
+            - (Object.Id)
+      returns:
+        - (Object)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/object/metadata.mdx
+---
+
+## Retrieve metadata
+
+Retrieve metadata about an object. The value itself is not returned.
+
+<CodeBlock referenceId="describe_object">
+  <CodeBlockTab title="Request" file="describe-object-request" />
+  <CodeBlockTab title="Response" file="get-object-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/vault/object/update.mdx

@@ -0,0 +1,67 @@
+---
+reference:
+  curl:
+    - key: update_object
+      id: update_object
+      url: /reference/vault/object/update
+      title: '/vault/v1/kv/:id'
+      type: PUT
+      parameters:
+        - (object.id)
+        - (object.value)
+        - key: version_check
+          optional: true
+          type: string
+          description: (object_metadata.version_check)
+      returns:
+        - (object.id)
+        - (object.name)
+        - (object.metadata)
+  js:
+    - key: updateObject
+      id: update_object
+      url: /reference/vault/object/update
+      title: vault.updateObject()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - (Object.id)
+            - (Object.value)
+            - key: versionCheck
+              optional: true
+              type: string
+              description: (object_metadata.version_check)
+      returns:
+        - (Object)
+  go:
+    - key: UpdateObject
+      id: update_object
+      url: /reference/vault/object/update
+      title: vault.UpdateObject()
+      parameters:
+        - (ctx)
+        - key: opts
+          type: vault.UpdateObjectOpts
+          expanded: true
+          properties:
+            - (Object.Id)
+            - (Object.Value)
+            - key: VersionCheck
+              optional: true
+              type: string
+              description: (object_metadata.version_check)
+      returns:
+        - (Object)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/object/update.mdx
+---
+
+## Update an object value
+
+Update the value for an object. The key context of the original object will be used to encrypt the new data.
+
+<CodeBlock referenceId="update_object">
+  <CodeBlockTab title="Request" file="update-object-request" />
+  <CodeBlockTab title="Response" file="get-object-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/vault/object/version.mdx

@@ -0,0 +1,87 @@
+---
+descriptions:
+  object_version:
+    self: 'The Vault [Object Version](/reference/vault/object/version).'
+    id: Unique string ID of the version.
+    current_version: Boolean indicating whether this version is the default for the object.
+    created_at: ISO 8601 timestamp of when this version was created.
+    size: Number of bytes of data stored in the object.
+    etag: A hash of the value of the object.
+reference:
+  curl:
+    - url: /reference/vault/object/version
+      key: object_version
+      id: object_version
+      title: object_version
+      properties:
+        - key: id
+          type: string
+          description: (object_version.id)
+        - key: current_version
+          type: boolean
+          description: (object_version.current_version)
+        - key: created_at
+          type: string
+          description: (object_version.created_at)
+        - key: size
+          type: integer
+          description: (object_version.size)
+        - key: etag
+          type: string
+          description: (object_version.etag)
+  js:
+    - url: /reference/vault/object/version
+      key: ObjectVersion
+      id: object_version
+      title: interface ObjectVersion
+      properties:
+        - key: id
+          type: string
+          description: (object_version.id)
+        - key: currentVersion
+          type: boolean
+          description: (object_version.current_version)
+        - key: createdAt
+          type: string
+          description: (object_version.created_at)
+        - key: size
+          type: integer
+          description: (object_version.size)
+        - key: etag
+          type: string
+          description: (object_version.etag)
+  go:
+    - url: /reference/vault/object/version
+      key: ObjectVersion
+      id: object_version
+      title: vault.ObjectVersion
+      properties:
+        - key: Id
+          type: string
+          description: (object_version.id)
+        - key: CurrentVersion
+          type: bool
+          description: (object_version.current_version)
+        - key: CreatedAt
+          type: time.Time
+          description: (object_version.created_at)
+        - key: Size
+          type: int
+          description: (object_version.size)
+        - key: Etag
+          type: string
+          description: (object_version.etag)
+originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/object/version.mdx
+---
+
+---
+
+# Object Version
+
+Represents a static version of an object stored by Vault.
+
+<CodeBlock
+  title="Object Version"
+  referenceId="object-version"
+  file="object-version"
+/>