@workos/mcp-docs-server 0.1.0 → 0.2.0

package/.docs/organized/docs/reference/fga/resource/get.mdx

@@ -1,86 +1,38 @@
 ---
+descriptions:
+  get_resource:
+    resource_id: The ID of the resource to retrieve.
 reference:
   curl:
     - key: get_resource
       id: get_resource
-      url: /reference/fga/resources/get
-      title: '/fga/v1/resources/:resource_type/:resource_id'
+      url: /reference/fga/resource/get
+      title: '/authorization/resources/:resource_id'
       type: GET
       parameters:
-        - (resource.resource_type)
-        - (resource.resource_id)
+        - key: resource_id
+          type: string
+          description: (get_resource.resource_id)
       returns:
         - (resource)
   js:
     - key: getResource
       id: get_resource
-      url: /reference/fga/resources/get
-      title: fga.getResource()
-      type: GET
+      url: /reference/fga/resource/get
+      title: authorization.getResource()
       parameters:
-        - key: options
-          type: object
-          unwrap: true
-          properties:
-            - (Resource.resourceType)
-            - (Resource.resourceId)
+        - key: resourceId
+          type: string
+          description: (get_resource.resource_id)
       returns:
-        - (Resource)
-  go:
-    - key: GetResource
-      id: get_resource
-      url: /reference/fga/resources/get
-      title: fga.GetResource()
-      type: GET
-      parameters:
-        - (ctx)
-        - key: opts
-          type: fga.GetResourceOpts
-          unwrap: true
-          properties:
-            - key: ResourceType
-              type: string
-              description: (resource.resource_type)
-            - key: ResourceId
-              type: string
-              description: (resource.resource_id)
-      returns:
-        - key: resource
-          type: fga.Resource
+        - key: AuthorizationResource
           description: (resource.self)
-        - (err)
-  java:
-    - key: getResource
-      id: get_resource
-      url: /reference/fga/resources/get
-      title: fga.getResource()
-      type: GET
-      parameters:
-        - (Resource.resourceType)
-        - (Resource.resourceId)
-      returns:
-        - (Resource)
-  python:
-    - key: get_resource
-      id: get_resource
-      url: /reference/fga/resources/get
-      title: fga.get_resource()
-      type: GET
-      parameters:
-        - key: resource_type
-          type: str
-          description: (resource.resource_type)
-        - key: resource_id
-          type: str
-          description: (resource.resource_id)
-      returns:
-        - (Resource)
 originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource/get.mdx
 ---
 
 ## Get a resource
 
-Get an existing resource.
+Retrieve the details of an authorization resource by its ID.
 
 <CodeBlock referenceId="get_resource">
   <CodeBlockTab title="Request" file="get-resource-request" />

package/.docs/organized/docs/reference/fga/resource/index.mdx

@@ -1,98 +1,99 @@
 ---
 descriptions:
   resource:
-    self: 'The FGA [Resource](/reference/fga/resource).'
-    resource_type: The type of the resource.
-    resource_id: Unique string ID of the resource.
-    meta: A JSON resource containing additional information about this resource.
+    self: >-
+      The Resource object represents an entity in your application that can have
+      permissions assigned.
+    object: Distinguishes the Resource object.
+    id: Unique identifier of the Resource.
+    external_id: An identifier you provide to reference the resource in your system.
+    name: A human-readable name for the Resource.
+    description: An optional description for the Resource.
+    resource_type_slug: The slug of the resource type this resource belongs to.
+    parent_resource_id: 'The ID of the parent resource in the hierarchy, if any.'
+    organization_id: The ID of the organization this resource belongs to.
+    created_at: The timestamp when the Resource was created.
+    updated_at: The timestamp when the Resource was last updated.
 reference:
   curl:
     - url: /reference/fga/resource
       key: resource
       id: resource
-      title: resource
+      title: Resource
       properties:
-        - key: resource_type
+        - key: object
+          type: '"authorization_resource"'
+          description: (resource.object)
+        - key: id
           type: string
-          description: (resource.resource_type)
-        - key: resource_id
+          description: (resource.id)
+        - key: external_id
           type: string
-          description: (resource.resource_id)
-        - key: meta
-          type: object
-          optional: true
-          description: (resource.meta)
-  js:
-    - url: /reference/fga/resource
-      key: Resource
-      id: resource
-      title: interface BaseWarrantResource
-      properties:
-        - key: resourceType
+          description: (resource.external_id)
+        - key: name
           type: string
-          description: (resource.resource_type)
-        - key: resourceId
+          description: (resource.name)
+        - key: description
+          type: string | null
+          description: (resource.description)
+        - key: resource_type_slug
           type: string
-          description: (resource.resource_id)
-        - key: meta
-          type: object
-          optional: true
-          description: (resource.meta)
-  go:
-    - url: /reference/fga/resource
-      key: Resource
-      id: resource
-      title: fga.Resource
-      properties:
-        - key: ResourceType
+          description: (resource.resource_type_slug)
+        - key: parent_resource_id
+          type: string | null
+          description: (resource.parent_resource_id)
+        - key: organization_id
           type: string
-          description: (resource.resource_type)
-        - key: ResourceId
+          description: (resource.organization_id)
+        - key: created_at
           type: string
-          description: (resource.resource_id)
-        - key: Meta
-          type: object
-          optional: true
-          description: (resource.meta)
-  java:
-    - url: /reference/fga/resource
-      key: Resource
-      id: resource
-      title: class Resource
-      properties:
-        - key: resourceType
-          type: String
-          description: (resource.resource_type)
-        - key: resourceId
-          type: String
-          description: (resource.resource_id)
-        - key: meta
-          type: 'Map<String, String>'
-          optional: true
-          description: (resource.meta)
-  python:
+          description: (resource.created_at)
+        - key: updated_at
+          type: string
+          description: (resource.updated_at)
+  js:
     - url: /reference/fga/resource
-      key: Resource
+      key: AuthorizationResource
       id: resource
       title: AuthorizationResource
       properties:
-        - key: resource_type
-          type: str
-          description: (resource.resource_type)
-        - key: resource_id
-          type: str
-          description: (resource.resource_id)
-        - key: meta
-          type: dict
-          optional: true
-          description: (resource.meta)
+        - key: object
+          type: '"authorization_resource"'
+          description: (resource.object)
+        - key: id
+          type: string
+          description: (resource.id)
+        - key: externalId
+          type: string
+          description: (resource.external_id)
+        - key: name
+          type: string
+          description: (resource.name)
+        - key: description
+          type: string | null
+          description: (resource.description)
+        - key: resourceTypeSlug
+          type: string
+          description: (resource.resource_type_slug)
+        - key: parentResourceId
+          type: string | null
+          description: (resource.parent_resource_id)
+        - key: organizationId
+          type: string
+          description: (resource.organization_id)
+        - key: createdAt
+          type: string
+          description: (resource.created_at)
+        - key: updatedAt
+          type: string
+          description: (resource.updated_at)
 originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource/index.mdx
 ---
 
----
-
 # Resource
 
-Represents a resource in your application.
+A resource is an instance of a [resource type](/fga/resource-types) that represents an entity in your application. Resources can be workspaces, projects, apps, or any other object that users can access.
+
+Resources are organized in a hierarchy. When a role is assigned to a user on a parent resource, they automatically gain access to child resources through permission inheritance.
 
-<CodeBlock title="Resource" referenceId="resource" file="resource" />
+<CodeBlock title="Resource" file="resource" referenceId="resource" />

package/.docs/organized/docs/reference/fga/resource/list.mdx

@@ -1,186 +1,145 @@
 ---
 descriptions:
   list_resources:
-    data: 'Array of [Resources](/reference/fga/resource).'
-    resource_type: Only return resources with an `resource_type` matching this value.
-    search: >-
-      Only returns resources where `resource_type` and/or `resource_id` contain
-      the search term.
+    organization_id: Filter resources by organization ID.
+    resource_type_slug: Filter resources by resource type slug.
+    parent_resource_id: Filter resources by parent resource ID.
+    parent_resource_type_slug: Filter resources by parent resource type slug.
+    parent_external_id: Filter resources by parent external ID.
+    search: Search resources by name.
+    limit: 'Maximum number of records to return (default 10, max 100).'
+    before: Cursor for pagination (before).
+    after: Cursor for pagination (after).
+    order: Sort order (asc or desc).
+    data: 'Array of [Resource](/reference/fga/resource) objects.'
 reference:
   curl:
     - key: list_resources
       id: list_resources
       url: /reference/fga/resource/list
-      title: /fga/v1/resources
+      title: /authorization/resources
       type: GET
       parameters:
-        - key: resource_type
+        - key: organization_id
           type: string
           optional: true
-          description: (list_resources.resource_type)
+          description: (list_resources.organization_id)
+        - key: resource_type_slug
+          type: string
+          optional: true
+          description: (list_resources.resource_type_slug)
+        - key: parent_resource_id
+          type: string
+          optional: true
+          description: (list_resources.parent_resource_id)
+        - key: parent_resource_type_slug
+          type: string
+          optional: true
+          description: (list_resources.parent_resource_type_slug)
+        - key: parent_external_id
+          type: string
+          optional: true
+          description: (list_resources.parent_external_id)
         - key: search
           type: string
           optional: true
           description: (list_resources.search)
-        - (limit)
-        - (before)
-        - (after)
-        - (order)
+        - key: limit
+          type: number
+          optional: true
+          description: (list_resources.limit)
+        - key: before
+          type: string
+          optional: true
+          description: (list_resources.before)
+        - key: after
+          type: string
+          optional: true
+          description: (list_resources.after)
+        - key: order
+          type: '"asc" | "desc"'
+          optional: true
+          description: (list_resources.order)
       returns:
-        - key: data
-          type: array
-          description: (list_resources.data)
-        - key: list_metadata
+        - key: anonymous
           type: object
+          unwrap: true
           properties:
-            - (before)
-            - (after)
+            - key: data
+              type: array
+              description: (list_resources.data)
+            - key: list_metadata
+              type: object
+              properties:
+                - key: before
+                  type: string | null
+                - key: after
+                  type: string | null
   js:
     - key: listResources
       id: list_resources
-      url: /reference/resources/list
-      title: fga.listResources()
-      type: GET
+      url: /reference/fga/resource/list
+      title: authorization.listResources()
       parameters:
         - key: options
           type: object
           unwrap: true
-          optional: true
           properties:
-            - key: resourceType
+            - key: organizationId
+              type: string
+              description: (list_resources.organization_id)
+            - key: resourceTypeSlug
+              type: string
+              optional: true
+              description: (list_resources.resource_type_slug)
+            - key: parentResourceId
+              type: string
+              optional: true
+              description: (list_resources.parent_resource_id)
+            - key: parentResourceTypeSlug
               type: string
               optional: true
-              description: (list_resources.resource_type)
+              description: (list_resources.parent_resource_type_slug)
+            - key: parentExternalId
+              type: string
+              optional: true
+              description: (list_resources.parent_external_id)
             - key: search
               type: string
               optional: true
               description: (list_resources.search)
-            - (limit)
-            - (before)
-            - (after)
-            - (order)
-      returns:
-        - key: anonymous
-          type: object
-          unwrap: true
-          properties:
-            - key: data
-              type: 'Resource[]'
-              description: (list_resources.data)
-            - key: listMetadata
-              type: object
-              properties:
-                - (before)
-                - (after)
-  go:
-    - key: ListResources
-      id: list_resources
-      url: /reference/resources/list
-      title: fga.ListResources()
-      type: GET
-      parameters:
-        - (ctx)
-        - key: opts
-          type: fga.ListResourcesOpts
-          unwrap: true
-          properties:
-            - key: ResourceType
+            - key: limit
+              type: number
               optional: true
+              description: (list_resources.limit)
+            - key: before
               type: string
-              description: (list_resources.resource_type)
-            - key: Search
               optional: true
+              description: (list_resources.before)
+            - key: after
               type: string
-              description: (list_resources.search)
-            - (Limit)
-            - (Before)
-            - (After)
-            - (Order)
-      returns:
-        - key: resources
-          type: ListResourcesResponse
-          unwrap: true
-          properties:
-            - key: Data
-              type: 'User[]'
-              description: (list_resources.data)
-            - key: ListMetadata
-              type: ListMetadata
-              properties:
-                - (Before)
-                - (After)
-        - (err)
-  java:
-    - key: listResources
-      id: list_resources
-      url: /reference/resources/list
-      title: fga.listResources()
-      type: GET
-      parameters:
-        - key: options
-          type: ListResourcesOptions
-          optional: true
-          unwrap: true
-          properties:
-            - key: resourceType
-              type: String
               optional: true
-              description: (list_resources.resource_type)
-            - key: search
-              type: String
+              description: (list_resources.after)
+            - key: order
+              type: '"asc" | "desc"'
               optional: true
-              description: (list_resources.search)
-            - (limit)
-            - (before)
-            - (after)
-            - (order)
+              description: (list_resources.order)
       returns:
         - key: anonymous
-          type: Resources
+          type: object
           unwrap: true
           properties:
             - key: data
-              type: 'Array[Resource]'
+              type: 'AuthorizationResource[]'
               description: (list_resources.data)
             - key: listMetadata
               type: ListMetadata
-              properties:
-                - (before)
-                - (after)
-  python:
-    - key: list_resources
-      id: list_resources
-      url: /reference/resources/list
-      title: fga.list_resources()
-      type: GET
-      parameters:
-        - key: resource_type
-          type: str
-          optional: true
-          description: (list_resources.resource_type)
-        - key: search
-          type: str
-          optional: true
-          description: (list_resources.search)
-        - (limit)
-        - (before)
-        - (after)
-        - (order)
-      returns:
-        - key: data
-          type: 'List[AuthorizationResource]'
-          description: (list_resources.data)
-        - key: list_metadata
-          type: dict
-          properties:
-            - (before)
-            - (after)
 originalPath: .tmp-workos-clone/packages/docs/content/reference/fga/resource/list.mdx
 ---
 
 ## List resources
 
-Get a list of all your existing resources matching the criteria specified.
+Get a paginated list of authorization resources. Use query parameters to filter by organization, resource type, or parent resource.
 
 <CodeBlock referenceId="list_resources">
   <CodeBlockTab title="Request" file="list-resources-request" />

package/.docs/organized/docs/reference/fga/resource/update-by-external-id.mdx

@@ -0,0 +1,81 @@
+---
+descriptions:
+  update_resource_by_external_id:
+    organization_id: The ID of the organization.
+    resource_type_slug: The slug of the resource type.
+    external_id: The external ID of the resource.
+    name: The new name for the resource.
+    description: The new description for the resource. Pass null to remove the description.
+reference:
+  curl:
+    - key: update_resource_by_external_id
+      id: update_resource_by_external_id
+      url: /reference/fga/resource/update-by-external-id
+      title: >-
+        /authorization/organizations/:organization_id/resources/:resource_type_slug/:external_id
+      type: PATCH
+      parameters:
+        - key: organization_id
+          type: string
+          description: (update_resource_by_external_id.organization_id)
+        - key: resource_type_slug
+          type: string
+          description: (update_resource_by_external_id.resource_type_slug)
+        - key: external_id
+          type: string
+          description: (update_resource_by_external_id.external_id)
+        - key: name
+          type: string
+          optional: true
+          description: (update_resource_by_external_id.name)
+        - key: description
+          type: string | null
+          optional: true
+          description: (update_resource_by_external_id.description)
+      returns:
+        - (resource)
+  js:
+    - key: updateResourceByExternalId
+      id: update_resource_by_external_id
+      url: /reference/fga/resource/update-by-external-id
+      title: authorization.updateResourceByExternalId()
+      parameters:
+        - key: options
+          type: object
+          unwrap: true
+          properties:
+            - key: organizationId
+              type: string
+              description: (update_resource_by_external_id.organization_id)
+            - key: resourceTypeSlug
+              type: string
+              description: (update_resource_by_external_id.resource_type_slug)
+            - key: externalId
+              type: string
+              description: (update_resource_by_external_id.external_id)
+            - key: name
+              type: string
+              optional: true
+              description: (update_resource_by_external_id.name)
+            - key: description
+              type: string | null
+              optional: true
+              description: (update_resource_by_external_id.description)
+      returns:
+        - key: AuthorizationResource
+          description: (resource.self)
+originalPath: >-
+  .tmp-workos-clone/packages/docs/content/reference/fga/resource/update-by-external-id.mdx
+---
+
+## Update a resource by external ID
+
+Update an existing authorization resource using its external ID. Only the fields provided will be updated.
+
+<CodeBlock referenceId="update_resource_by_external_id">
+  <CodeBlockTab title="Request" file="update-resource-by-external-id-request" />
+  <CodeBlockTab
+    title="Response"
+    file="update-resource-by-external-id-response"
+  />
+</CodeBlock>