@workos/mcp-docs-server 0.1.0 → 0.2.0

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

@@ -37,6 +37,17 @@ reference:
             - (Object.Id)
       returns:
         - (Object)
+  python:
+    - key: read_object
+      id: get_object
+      url: /reference/vault/object/get
+      title: vault.read_object()
+      parameters:
+        - key: object_id
+          type: str
+          description: (object.id)
+      returns:
+        - (VaultObject)
 originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/object/get.mdx
 ---
 

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

@@ -14,8 +14,8 @@ descriptions:
     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.
+        Name of the user or [API key](/reference/api-authentication) 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
@@ -162,11 +162,57 @@ reference:
             - key: VersionId
               type: string
               description: (object_metadata.version_id)
+  python:
+    - url: /reference/vault/object
+      key: VaultObject
+      id: object
+      title: vault.VaultObject
+      properties:
+        - key: id
+          type: str
+          description: (object.id)
+        - key: name
+          type: str
+          description: (object.name)
+        - key: value
+          type: str
+          optional: true
+          description: (object.value)
+        - key: metadata
+          type: vault.ObjectMetadata
+          expanded: true
+          properties:
+            - key: id
+              type: str
+              description: (object.id)
+            - key: environment_id
+              type: str
+              description: (object_metadata.environment_id)
+            - key: context
+              type: vault.KeyContext
+              description: (object_metadata.context)
+            - key: key_id
+              type: str
+              description: (object_metadata.key_id)
+            - key: updated_at
+              type: str
+              description: (object_metadata.updated_at)
+            - key: updated_by
+              type: vault.ObjectUpdatedBy
+              expanded: true
+              properties:
+                - key: id
+                  type: str
+                  description: (object_metadata.updated_by.id)
+                - key: name
+                  type: str
+                  description: (object_metadata.updated_by.name)
+            - key: version_id
+              type: str
+              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.

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

@@ -1,4 +1,8 @@
 ---
+descriptions:
+  updatedAfter: >-
+    ISO 8601 timestamp used to filter results. Only objects updated after this
+    timestamp will be returned.
 reference:
   curl:
     - key: list_objects
@@ -10,6 +14,10 @@ reference:
         - (limit)
         - (before)
         - (after)
+        - key: updatedAfter
+          optional: true
+          type: DateTime
+          description: (updatedAfter)
       returns:
         - key: anonymous
           type: object
@@ -76,7 +84,7 @@ reference:
             - (After)
       returns:
         - key: listResponse
-          type: vault.ListObjectVersionsResponse
+          type: vault.ListObjectsResponse
           unwrap: true
           properties:
             - key: data
@@ -92,6 +100,37 @@ reference:
               properties:
                 - (Before)
                 - (After)
+  python:
+    - key: list_objects
+      id: list_objects
+      url: /reference/vault/object/list
+      title: vault.list_objects()
+      parameters:
+        - (limit)
+        - (before)
+        - (after)
+      returns:
+        - key: paginated_objects
+          type: vault.VaultObjectList
+          unwrap: true
+          properties:
+            - key: data
+              type: 'vault.ObjectDigest[]'
+              properties:
+                - key: id
+                  type: str
+                  description: (object.id)
+                - key: name
+                  type: str
+                  description: (object.name)
+                - key: updated_at
+                  type: str
+                  description: (object_metadata.updated_at)
+            - key: ListMetadata
+              type: ListMetadata
+              properties:
+                - (before)
+                - (after)
 originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/object/list.mdx
 ---
 

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

@@ -54,6 +54,24 @@ reference:
               description: (object_metadata.version_check)
       returns:
         - (Object)
+  python:
+    - key: update_object
+      id: update_object
+      url: /reference/vault/object/update
+      title: vault.update_object()
+      parameters:
+        - key: object_id
+          type: str
+          description: (object.id)
+        - key: value
+          type: str
+          description: (object.value)
+        - key: version_check
+          type: str
+          optional: true
+          description: (object_metadata.version_check)
+      returns:
+        - (VaultObject)
 originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/object/update.mdx
 ---
 

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

@@ -71,11 +71,24 @@ reference:
         - key: Etag
           type: string
           description: (object_version.etag)
+  python:
+    - url: /reference/vault/object/version
+      key: ObjectVersion
+      id: object_version
+      title: vault.ObjectVersion
+      properties:
+        - key: id
+          type: str
+          description: (object_version.id)
+        - key: current_version
+          type: bool
+          description: (object_version.current_version)
+        - key: created_at
+          type: str
+          description: (object_version.created_at)
 originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/object/version.mdx
 ---
 
----
-
 # Object Version
 
 Represents a static version of an object stored by Vault.

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

@@ -70,6 +70,19 @@ reference:
             - key: data
               type: 'ObjectVersion[]'
               description: (list_object_versions.data)
+  python:
+    - key: list_object_versions
+      id: list_object_versions
+      url: /reference/vault/object/versions
+      title: vault.list_object_versions()
+      parameters:
+        - key: object_id
+          type: str
+          description: (object.id)
+      returns:
+        - key: data
+          type: 'ObjectVersion[]'
+          description: (list_object_versions.data)
 originalPath: .tmp-workos-clone/packages/docs/content/reference/vault/object/versions.mdx
 ---
 

package/.docs/organized/docs/reference/widgets/get-token.mdx

@@ -3,10 +3,11 @@ descriptions:
   widget_token: An ephemeral token to access WorkOS widgets.
   get_token:
     organization_id: 'An [Organization](/reference/organization) identifier.'
-    user_id: 'A [User](/reference/user-management/user) identifier.'
+    user_id: 'A [User](/reference/authkit/user) identifier.'
     scopes: >-
-      The scopes to grant the widget token. Currently supported scope is
-      `widgets:users-table:manage`.
+      Scopes to include in the widget token. If a user_id is provided, the
+      requested scopes will be also be restricted to the permissions that the
+      user has in the requested organization.
 reference:
   curl:
     - key: get_token
@@ -21,8 +22,9 @@ reference:
         - key: user_id
           type: string
           description: (get_token.user_id)
+          optional: true
         - key: scopes
-          type: array
+          type: '"widgets:users-table:manage"[]'
           description: (get_token.scopes)
       returns:
         - key: anonymous
@@ -66,9 +68,10 @@ reference:
               description: (get_token.organization_id)
             - key: userId
               type: string
+              optional: true
               description: (get_token.user_id)
             - key: scopes
-              type: 'string[]'
+              type: '"widgets:users-table:manage"[]'
               description: (get_token.scopes)
       returns:
         - key: token

package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/create.mdx

@@ -0,0 +1,55 @@
+---
+descriptions:
+  create_client_secret:
+    id_parameter: The application ID or client ID.
+reference:
+  curl:
+    - key: create_client_secret
+      type: POST
+      id: create_client_secret
+      url: /reference/workos-connect/applications/client-secrets/create
+      title: '/connect/applications/:id/client_secrets'
+      parameters:
+        - key: id
+          type: string
+          description: (create_client_secret.id_parameter)
+      returns:
+        - key: connect_application_secret
+          type: object
+          description: A connect_application_secret object with the plaintext secret
+          properties:
+            - key: object
+              type: string
+              description: Always "connect_application_secret"
+            - key: id
+              type: string
+              description: Unique identifier for the client secret
+            - key: secret
+              type: string
+              description: The plaintext client secret (only returned at creation time)
+            - key: secret_hint
+              type: string
+              description: A hint showing the first few characters of the secret
+            - key: last_used_at
+              type: string | null
+              description: ISO 8601 timestamp of when the secret was last used
+            - key: created_at
+              type: string
+              description: ISO 8601 timestamp of creation
+            - key: updated_at
+              type: string
+              description: ISO 8601 timestamp of last update
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/workos-connect/applications/client-secrets/create.mdx
+---
+
+## Create a Client Secret
+
+Create a new client secret for a Connect Application.
+
+This is the only time the plaintext secret will be returned and must be stored securely.
+
+<CodeBlock referenceId="create_client_secret">
+  <CodeBlockTab title="Request" file="create-client-secret-request" />
+  <CodeBlockTab title="Response" file="create-client-secret-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/delete.mdx

@@ -0,0 +1,28 @@
+---
+descriptions:
+  delete_client_secret:
+    id_parameter: The client secret ID.
+reference:
+  curl:
+    - key: delete_client_secret
+      type: DELETE
+      id: delete_client_secret
+      url: /reference/workos-connect/applications/client-secrets/delete
+      title: '/connect/client_secrets/:id'
+      parameters:
+        - key: id
+          type: string
+          description: (delete_client_secret.id_parameter)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/workos-connect/applications/client-secrets/delete.mdx
+---
+
+## Delete a Client Secret
+
+Delete (revoke) an existing client secret.
+
+<CodeBlock
+  file="delete-client-secret-request"
+  referenceId="delete_client_secret"
+  title="Request"
+/>

package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/index.mdx

@@ -0,0 +1,60 @@
+---
+descriptions:
+  connect_application_secret:
+    self: A client secret for a Connect Application.
+    object: Always "connect_application_secret".
+    id: Unique identifier for the client secret.
+    secret_hint: A hint showing the last few characters of the secret.
+    last_used_at: >-
+      ISO 8601 timestamp of when the secret was last used, or null if never
+      used.
+    created_at: ISO 8601 timestamp of creation.
+    updated_at: ISO 8601 timestamp of last update.
+    secret: >-
+      The plaintext client secret. This is only returned at creation time and
+      cannot be retrieved later.
+reference:
+  curl:
+    - url: /reference/workos-connect/applications/client-secrets
+      key: connect_application_secret
+      id: connect_application_secret
+      title: connect_application_secret
+      properties:
+        - key: object
+          type: '"connect_application_secret"'
+          description: (connect_application_secret.object)
+        - key: id
+          type: string
+          description: (connect_application_secret.id)
+        - key: secret_hint
+          type: string
+          description: (connect_application_secret.secret_hint)
+        - key: last_used_at
+          optional: true
+          type: string
+          description: (connect_application_secret.last_used_at)
+        - key: created_at
+          type: string
+          description: (connect_application_secret.created_at)
+        - key: updated_at
+          type: string
+          description: (connect_application_secret.updated_at)
+        - key: secret
+          optional: true
+          type: string
+          description: (connect_application_secret.secret)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/workos-connect/applications/client-secrets/index.mdx
+---
+
+# Client Secrets
+
+Client secrets are used to authenticate Connect Applications when making requests to WorkOS APIs.
+
+When a client secret is first created, the response includes an additional `secret` field containing the plaintext secret. This is the only time the plaintext secret will be returned.
+
+<CodeBlock
+  title="Example Client Secret"
+  file="connect-application-secret"
+  referenceId="connect_application_secret"
+/>

package/.docs/organized/docs/reference/workos-connect/applications/client-secrets/list.mdx

@@ -0,0 +1,52 @@
+---
+descriptions:
+  list_client_secrets:
+    id_parameter: The application ID or client ID.
+reference:
+  curl:
+    - key: list_client_secrets
+      type: GET
+      id: list_client_secrets
+      url: /reference/workos-connect/applications/client-secrets/list
+      title: '/connect/applications/:id/client_secrets'
+      parameters:
+        - key: id
+          type: string
+          description: (list_client_secrets.id_parameter)
+      returns:
+        - key: client_secrets
+          type: array
+          description: Array of connect_application_secret objects
+          properties:
+            - key: object
+              type: string
+              description: Always "connect_application_secret"
+            - key: id
+              type: string
+              description: Unique identifier for the client secret
+            - key: secret_hint
+              type: string
+              description: A hint showing the first few characters of the secret
+            - key: last_used_at
+              type: string | null
+              description: ISO 8601 timestamp of when the secret was last used
+            - key: created_at
+              type: string
+              description: ISO 8601 timestamp of creation
+            - key: updated_at
+              type: string
+              description: ISO 8601 timestamp of last update
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/workos-connect/applications/client-secrets/list.mdx
+---
+
+## List Client Secrets
+
+List all client secrets associated with a Connect Application.
+
+The plaintext secret is never returned after creation. Only the secret hint is included.
+
+<CodeBlock referenceId="list_client_secrets">
+  <CodeBlockTab title="Request" file="list-client-secrets-request" />
+  <CodeBlockTab title="Response" file="list-client-secrets-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/workos-connect/applications/create.mdx

@@ -0,0 +1,79 @@
+---
+descriptions:
+  create_connect_application:
+    name: Name of the application.
+    application_type: Type of application - either "oauth" or "m2m".
+    description: Description of the application.
+    scopes: Permission slugs to assign to the application.
+    redirect_uris: Redirect URIs for the application. OAuth applications only.
+    uses_pkce: >-
+      Whether the application uses PKCE (Proof Key for Code Exchange). OAuth
+      applications only.
+    is_first_party: >-
+      Whether this is a first-party application. Required for OAuth
+      applications.
+    organization_id: >-
+      The organization ID this application belongs to. Required for M2M
+      applications. For OAuth applications, required if is_first_party is false.
+reference:
+  curl:
+    - key: create_connect_application
+      type: POST
+      id: create_connect_application
+      url: /reference/workos-connect/applications/create
+      title: /connect/applications
+      parameters:
+        - key: name
+          type: string
+          description: (create_connect_application.name)
+        - key: application_type
+          type: string
+          description: (create_connect_application.application_type)
+        - key: description
+          optional: true
+          type: string
+          description: (create_connect_application.description)
+        - key: scopes
+          optional: true
+          type: 'string[]'
+          description: (create_connect_application.scopes)
+        - key: redirect_uris
+          optional: true
+          type: array
+          description: (create_connect_application.redirect_uris)
+          properties:
+            - key: uri
+              type: string
+              description: The redirect URI
+            - key: default
+              optional: true
+              type: boolean
+              description: Whether this is the default redirect URI
+        - key: uses_pkce
+          optional: true
+          type: boolean
+          description: (create_connect_application.uses_pkce)
+        - key: is_first_party
+          type: boolean
+          description: (create_connect_application.is_first_party)
+        - key: organization_id
+          optional: true
+          type: string
+          description: (create_connect_application.organization_id)
+      returns:
+        - key: connect_application
+          type: object
+          description: The created connect_application object
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/workos-connect/applications/create.mdx
+---
+
+## Create a Connect Application
+
+Create a new Connect Application. Supports both OAuth and Machine-to-Machine (M2M) application types.
+
+<CodeBlock referenceId="create_connect_application">
+  <CodeBlockTab title="OAuth Request" file="create-oauth-application-request" />
+  <CodeBlockTab title="M2M Request" file="create-m2m-application-request" />
+  <CodeBlockTab title="Response" file="create-connect-application-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/workos-connect/applications/delete.mdx

@@ -0,0 +1,28 @@
+---
+descriptions:
+  delete_connect_application:
+    id_parameter: The application ID or client ID.
+reference:
+  curl:
+    - key: delete_connect_application
+      type: DELETE
+      id: delete_connect_application
+      url: /reference/workos-connect/applications/delete
+      title: '/connect/applications/:id'
+      parameters:
+        - key: id
+          type: string
+          description: (delete_connect_application.id_parameter)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/workos-connect/applications/delete.mdx
+---
+
+## Delete a Connect Application
+
+Delete an existing Connect Application.
+
+<CodeBlock
+  file="delete-connect-application-request"
+  referenceId="delete_connect_application"
+  title="Request"
+/>

package/.docs/organized/docs/reference/workos-connect/applications/get.mdx

@@ -0,0 +1,59 @@
+---
+descriptions:
+  get_connect_application:
+    id_parameter: The application ID or client ID.
+reference:
+  curl:
+    - key: get_connect_application
+      type: GET
+      id: get_connect_application
+      url: /reference/workos-connect/applications/get
+      title: '/connect/applications/:id'
+      parameters:
+        - key: id
+          type: string
+          description: (get_connect_application.id_parameter)
+      returns:
+        - key: connect_application
+          type: object
+          description: A connect_application object
+          properties:
+            - key: object
+              type: string
+              description: Always "connect_application"
+            - key: id
+              type: string
+              description: Unique identifier for the application
+            - key: client_id
+              type: string
+              description: OAuth client ID for the application
+            - key: name
+              type: string
+              description: Name of the application
+            - key: description
+              type: string | null
+              description: Description of the application
+            - key: application_type
+              type: string
+              description: Type of application - either "oauth" or "m2m"
+            - key: scopes
+              type: 'string[]'
+              description: Permission slugs assigned to the application
+            - key: created_at
+              type: string
+              description: ISO 8601 timestamp of creation
+            - key: updated_at
+              type: string
+              description: ISO 8601 timestamp of last update
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/workos-connect/applications/get.mdx
+---
+
+## Get a Connect Application
+
+Retrieve details for a specific Connect Application by ID or client ID.
+
+<CodeBlock referenceId="get_connect_application">
+  <CodeBlockTab title="Request" file="get-connect-application-request" />
+  <CodeBlockTab title="Response" file="get-connect-application-response" />
+</CodeBlock>

package/.docs/organized/docs/reference/workos-connect/applications/index.mdx

@@ -0,0 +1,40 @@
+---
+descriptions:
+  connect_application:
+    self: A Connect Application object.
+    object: Always "connect_application".
+    id: Unique identifier for the application.
+    client_id: OAuth client ID for the application.
+    name: Name of the application.
+    description: Description of the application.
+    application_type: Type of application - either "oauth" or "m2m".
+    scopes: Permission slugs assigned to the application.
+    created_at: ISO 8601 timestamp of creation.
+    updated_at: ISO 8601 timestamp of last update.
+    redirect_uris: Redirect URIs configured for OAuth applications.
+    uses_pkce: Whether the OAuth application uses PKCE (Proof Key for Code Exchange).
+    is_first_party: |
+      Whether this is a first-party OAuth application.
+
+      This is false for third-party applications which are owned by an
+      Organization.
+    was_dynamically_registered: >
+      Whether the OAuth application was dynamically registered.
+
+
+      Read more about Dynamic Client Registration and MCP auth in [our
+      guide](/authkit/mcp/integrating/enabling-client-id-metadata-document).
+    organization_id: |
+      The organization ID this application belongs to.
+
+      First-party applications are managed by you, do not belong to an
+      Organization, and therefore will not have an `organization_id`.
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/workos-connect/applications/index.mdx
+---
+
+# Applications
+
+The Applications API allows you to programmatically manage Connect Applications and their associated client secrets.
+
+WorkOS Connect supports two types of applications: [OAuth](/reference/workos-connect/applications/oauth) and Machine-to-Machine [M2M](/reference/workos-connect/applications/m2m).