server_name
stringclasses 156
values | category
stringclasses 1
value | tool
stringlengths 176
38.2k
|
|---|---|---|
obsidian
|
other
|
{'type': 'function', 'name': 'obsidian_batch_get_file_contents', 'description': 'Return the contents of multiple files in your vault, concatenated with headers.', 'parameters': {'type': 'object', 'properties': {'filepaths': {'type': 'array', 'description': 'List of file paths to read', 'items': {'type': 'string', 'description': 'Path to a file (relative to your vault root)', 'format': 'path'}}}, 'required': ['filepaths'], 'additionalProperties': False}, 'strict': True}
|
obsidian
|
other
|
{'type': 'function', 'name': 'obsidian_complex_search', 'description': "Complex search for documents using a JsonLogic query. \n Supports standard JsonLogic operators plus 'glob' and 'regexp' for pattern matching. Results must be non-falsy.\n\n Use this tool when you want to do a complex search, e.g. for all documents with certain tags etc.", 'parameters': {'type': 'object', 'properties': {'query': {'type': 'object', 'description': 'JsonLogic query object. Example: {"glob": ["*.md", {"var": "path"}]} matches all markdown files'}}, 'required': ['query'], 'additionalProperties': False}, 'strict': True}
|
obsidian
|
other
|
{'type': 'function', 'name': 'obsidian_delete_file', 'description': 'Delete a file or directory from the vault.', 'parameters': {'type': 'object', 'properties': {'confirm': {'type': 'boolean', 'description': 'Confirmation to delete the file (must be true)', 'default': False}, 'filepath': {'type': 'string', 'description': 'Path to the file or directory to delete (relative to vault root)', 'format': 'path'}}, 'required': ['filepath', 'confirm'], 'additionalProperties': False}, 'strict': True}
|
obsidian
|
other
|
{'type': 'function', 'name': 'obsidian_get_file_contents', 'description': 'Return the content of a single file in your vault.', 'parameters': {'type': 'object', 'properties': {'filepath': {'type': 'string', 'description': 'Path to the relevant file (relative to your vault root).', 'format': 'path'}}, 'required': ['filepath'], 'additionalProperties': False}, 'strict': True}
|
obsidian
|
other
|
{'type': 'function', 'name': 'obsidian_get_periodic_note', 'description': 'Get current periodic note for the specified period.', 'parameters': {'type': 'object', 'properties': {'period': {'type': 'string', 'description': 'The period type (daily, weekly, monthly, quarterly, yearly)', 'enum': ['daily', 'weekly', 'monthly', 'quarterly', 'yearly']}}, 'required': ['period'], 'additionalProperties': False}, 'strict': True}
|
obsidian
|
other
|
{'type': 'function', 'name': 'obsidian_get_recent_changes', 'description': 'Get recently modified files in the vault.', 'parameters': {'type': 'object', 'properties': {'days': {'type': 'integer', 'description': 'Only include files modified within this many days (default: 90)', 'default': 90, 'minimum': 1}, 'limit': {'type': 'integer', 'description': 'Maximum number of files to return (default: 10)', 'default': 10, 'minimum': 1, 'maximum': 100}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
obsidian
|
other
|
{'type': 'function', 'name': 'obsidian_get_recent_periodic_notes', 'description': 'Get most recent periodic notes for the specified period type.', 'parameters': {'type': 'object', 'properties': {'include_content': {'type': 'boolean', 'description': 'Whether to include note content (default: false)', 'default': False}, 'limit': {'type': 'integer', 'description': 'Maximum number of notes to return (default: 5)', 'default': 5, 'minimum': 1, 'maximum': 50}, 'period': {'type': 'string', 'description': 'The period type (daily, weekly, monthly, quarterly, yearly)', 'enum': ['daily', 'weekly', 'monthly', 'quarterly', 'yearly']}}, 'required': ['period'], 'additionalProperties': False}, 'strict': True}
|
obsidian
|
other
|
{'type': 'function', 'name': 'obsidian_list_files_in_dir', 'description': 'Lists all files and directories that exist in a specific Obsidian directory.', 'parameters': {'type': 'object', 'properties': {'dirpath': {'type': 'string', 'description': 'Path to list files from (relative to your vault root). Note that empty directories will not be returned.'}}, 'required': ['dirpath'], 'additionalProperties': False}, 'strict': True}
|
obsidian
|
other
|
{'type': 'function', 'name': 'obsidian_list_files_in_vault', 'description': 'Lists all files and directories in the root directory of your Obsidian vault.', 'parameters': {'type': 'object', 'properties': {}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
obsidian
|
other
|
{'type': 'function', 'name': 'obsidian_patch_content', 'description': 'Insert content into an existing note relative to a heading, block reference, or frontmatter field.', 'parameters': {'type': 'object', 'properties': {'content': {'type': 'string', 'description': 'Content to insert'}, 'filepath': {'type': 'string', 'description': 'Path to the file (relative to vault root)', 'format': 'path'}, 'operation': {'type': 'string', 'description': 'Operation to perform (append, prepend, or replace)', 'enum': ['append', 'prepend', 'replace']}, 'target': {'type': 'string', 'description': 'Target identifier (heading path, block reference, or frontmatter field)'}, 'target_type': {'type': 'string', 'description': 'Type of target to patch', 'enum': ['heading', 'block', 'frontmatter']}}, 'required': ['filepath', 'operation', 'target_type', 'target', 'content'], 'additionalProperties': False}, 'strict': True}
|
obsidian
|
other
|
{'type': 'function', 'name': 'obsidian_simple_search', 'description': 'Simple search for documents matching a specified text query across all files in the vault. \n Use this tool when you want to do a simple text search', 'parameters': {'type': 'object', 'properties': {'context_length': {'type': 'integer', 'description': 'How much context to return around the matching string (default: 100)', 'default': 100}, 'query': {'type': 'string', 'description': 'Text to a simple search for in the vault.'}}, 'required': ['query'], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'get_current_time', 'description': 'Get the current date and time in UTC, formatted for Okta API usage.\n\nReturns current UTC timestamp in ISO 8601 format with microseconds and Z suffix,\nsuitable for Okta API date parameters and filtering.\n\nBuffer Hours:\nUse buffer_hours to get times in the past (negative) or future (positive):\n• buffer_hours=0: Current time\n• buffer_hours=-24: 24 hours ago \n• buffer_hours=-168: 1 week ago (7*24 hours)\n• buffer_hours=24: 24 hours from now\n\nOutput Format:\nReturns timestamp in format: YYYY-MM-DDTHH:MM:SS.ffffffZ\nExample: 2024-06-23T14:30:15.123456Z\n\nUse Cases:\n• Log event filtering: since="2024-06-22T00:00:00.000Z"\n• User creation filters: lastUpdated gt "timestamp"\n• Application audit queries with time ranges\n• Policy rule time-based conditions\n\nPerfect for constructing Okta API queries that require precise timestamps.', 'parameters': {'type': 'object', 'properties': {'buffer_hours': {'type': 'integer', 'title': 'Buffer Hours', 'description': 'Optional number of hours to add/subtract from current time', 'default': 0}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'get_okta_application', 'description': 'Get detailed information about a specific Okta application.\n\nReturns comprehensive application details including:\n• Basic information: name, label, status, description\n• Sign-on configuration: mode, credentials, authentication settings\n• User assignment settings and policies\n• Group assignment configuration\n• Application-specific settings and features\n• Provisioning configuration (if applicable)\n• Application URLs and endpoints\n• Custom attributes and profile mappings\n\nApplication Status Values:\n• ACTIVE - Application is active and available to users\n• INACTIVE - Application is disabled and not available\n\nSign-On Modes:\n• SAML_2_0 - SAML 2.0 federation\n• OPENID_CONNECT - OpenID Connect/OAuth 2.0\n• SECURE_PASSWORD_STORE - Password-based with secure storage\n• AUTO_LOGIN - Automatic login with stored credentials\n• BOOKMARK - Simple bookmark/link application\n• BASIC_AUTH - HTTP Basic Authentication\n• BROWSER_PLUGIN - Browser plugin required\n• WS_FEDERATION - WS-Federation protocol\n\nUse this tool to get complete application configuration details for troubleshooting,\nauditing, or configuration review purposes.', 'parameters': {'type': 'object', 'properties': {'app_id': {'type': 'string', 'title': 'App Id', 'description': 'The ID of the application to retrieve'}}, 'required': ['app_id'], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'get_okta_event_logs', 'description': 'Get Okta system log events with comprehensive filtering and full pagination for complete audit trails.\n\nReturns detailed log events from Okta system logs including authentication, user management,\napplication access, policy changes, and administrative actions with complete audit information.\n\nTime Parameters:\n• since - Start time in ISO 8601 format: "2024-06-01T00:00:00.000Z"\n• until - End time in ISO 8601 format: "2024-06-23T23:59:59.999Z"\n• Use datetime tools to generate proper timestamps: parse_relative_time("24 hours ago")\n\nFilter Parameter:\nUses Okta expression language for precise event filtering:\n• eventType eq "user.authentication.auth" - Authentication events\n• eventType eq "user.lifecycle.create" - User creation events\n• eventType eq "user.lifecycle.activate" - User activation events\n• eventType eq "user.lifecycle.suspend" - User suspension events\n• eventType eq "application.lifecycle.create" - App creation events\n• outcome.result eq "SUCCESS" - Successful events only\n• outcome.result eq "FAILURE" - Failed events only\n• actor.id eq "user_id" - Events by specific user\n• target.id eq "target_id" - Events targeting specific resource\n\nCommon Event Types:\n• user.authentication.auth - User login attempts\n• user.authentication.sso - SSO authentication\n• user.session.start - Session initiation\n• user.session.end - Session termination\n• user.lifecycle.create - User creation\n• user.lifecycle.activate - User activation\n• user.lifecycle.suspend - User suspension\n• user.lifecycle.unsuspend - User reactivation\n• user.lifecycle.deactivate - User deactivation\n• application.user_membership.add - App assignment\n• application.user_membership.remove - App removal\n• group.user_membership.add - Group membership addition\n• group.user_membership.remove - Group membership removal\n• policy.lifecycle.create - Policy creation\n• policy.lifecycle.update - Policy modification\n\nSearch Parameter:\nFree-text search across event data:\n• Search for usernames, email addresses, application names\n• Search for IP addresses, client information\n• Search for error messages or specific text in events\n\nSort Order:\n• DESCENDING - Most recent events first (default)\n• ASCENDING - Oldest events first\n\nExample Filters:\n• Authentication failures: \'eventType eq "user.authentication.auth" and outcome.result eq "FAILURE"\'\n• User lifecycle changes: \'eventType sw "user.lifecycle"\'\n• Application events: \'eventType sw "application"\'\n• Admin actions: \'actor.type eq "User" and eventType sw "policy"\'\n• Specific user activity: \'actor.alternateId eq "user@company.com"\'\n\nThis tool uses full pagination to return complete audit trails for compliance,\nsecurity analysis, and forensic investigation purposes.\n\nUse for security monitoring, compliance auditing, troubleshooting authentication\nissues, and comprehensive log analysis.', 'parameters': {'type': 'object', 'properties': {'filter_string': {'type': 'string', 'title': 'Filter String', 'description': 'Filter expression for log events', 'default': ''}, 'q': {'type': 'string', 'title': 'Q', 'description': 'Search term for log events', 'default': ''}, 'since': {'type': 'string', 'title': 'Since', 'description': 'Starting time for log events (ISO 8601 format)', 'default': ''}, 'sort_order': {'type': 'string', 'title': 'Sort Order', 'description': 'Order of results (ASCENDING or DESCENDING)', 'default': 'DESCENDING'}, 'until': {'type': 'string', 'title': 'Until', 'description': 'Ending time for log events (ISO 8601 format)', 'default': ''}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'get_okta_group', 'description': 'Get detailed information about a specific Okta group.\n\nReturns comprehensive group information including:\n• Group profile (name, description, custom attributes)\n• Group type and classification\n• Membership statistics\n• Creation and modification timestamps\n• Group settings and configuration\n\nGroup Information Includes:\n• Basic details (ID, name, description)\n• Group type (OKTA_GROUP, BUILT_IN, APP_GROUP)\n• Profile attributes and custom fields\n• Administrative metadata\n• Object class and schema information\n\nGroup Types:\n• OKTA_GROUP - Standard organizational groups\n• BUILT_IN - System groups like "Everyone"\n• APP_GROUP - Application-specific groups\n\nCommon Use Cases:\n• Verify group configuration\n• Audit group settings and metadata\n• Get group details for membership operations\n• Compliance and access reviews\n• Troubleshoot group-related issues', 'parameters': {'type': 'object', 'properties': {'group_id': {'type': 'string', 'title': 'Group Id', 'description': 'The ID of the group to retrieve'}}, 'required': ['group_id'], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'get_okta_policy_rule', 'description': 'Get detailed information about a specific Okta policy rule.\n\nReturns comprehensive rule configuration including:\n• Authentication methods and requirements\n• Network zone constraints and IP restrictions\n• User and group targeting conditions\n• Device and platform requirements\n• Session management behaviors\n• Risk assessment criteria\n\nRule Details Include:\n• Rule identification (ID, name, description)\n• Activation status and priority\n• Condition expressions and logic\n• Action specifications and behaviors\n• Administrative metadata\n\nAuthentication Rule Information:\n• Required MFA factors and methods\n• Factor sequencing and fallbacks\n• Enrollment requirements\n• Verification policies\n\nNetwork Zone Constraints:\n• Allowed/blocked IP ranges\n• Geographic restrictions\n• Proxy and VPN handling\n• Dynamic zone evaluation\n\nAccess Control Actions:\n• Grant/deny decisions\n• Step-up authentication triggers\n• Session duration and management\n• Redirect behaviors\n\nRisk and Context Factors:\n• Device trust requirements\n• Location-based rules\n• Behavioral analysis integration\n• Threat intelligence inputs\n\nCommon Use Cases:\n• Detailed rule configuration review\n• Security policy troubleshooting\n• Compliance audit requirements\n• Rule modification planning\n• Access control verification', 'parameters': {'type': 'object', 'properties': {'policy_id': {'type': 'string', 'title': 'Policy Id', 'description': 'The ID of the policy that contains the rule'}, 'rule_id': {'type': 'string', 'title': 'Rule Id', 'description': 'The ID of the specific rule to retrieve'}}, 'required': ['policy_id', 'rule_id'], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'get_okta_user', 'description': 'Get detailed information about a specific Okta user.', 'parameters': {'type': 'object', 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'Enter the login of the user to retrieve details for'}}, 'required': ['user_id'], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'list_okta_application_groups', 'description': 'List all groups assigned to a specific Okta application with full pagination.\n\nReturns complete list of all groups assigned to the application including:\n• Group information (ID, name, description, type)\n• Assignment details and configuration\n• Group assignment scope and permissions\n• Application-specific group attributes\n• Assignment timestamps and metadata\n\nGroup Assignment Types:\n• Direct assignment - Group explicitly assigned to application\n• Inherited assignment - Group assigned via policy or rule\n\nGroup Types:\n• OKTA_GROUP - Standard Okta group\n• APP_GROUP - Application-imported group\n• BUILT_IN - Built-in Okta group (Everyone, etc.)\n\nAssignment Scope:\n• USER - Group assignment applies to user access\n• GROUP - Group assignment for group-level permissions\n\nThis tool uses full pagination to return ALL assigned groups, ensuring complete\nvisibility into group-based application access for security reviews and auditing.\n\nUse for application access governance, group assignment reviews, and troubleshooting\ngroup-based access issues.', 'parameters': {'type': 'object', 'properties': {'app_id': {'type': 'string', 'title': 'App Id', 'description': 'The ID of the application'}}, 'required': ['app_id'], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'list_okta_application_users', 'description': 'List all users assigned to a specific Okta application with full pagination.\n\nReturns complete list of all users assigned to the application including:\n• User profile information (ID, email, name, status)\n• Assignment details (scope, credentials, profile)\n• Assignment timestamps and metadata\n• Application-specific user attributes\n• User status within the application context\n\nAssignment Types:\n• Direct assignment - User assigned directly to application\n• Group assignment - User assigned via group membership\n• Rule-based assignment - User assigned via assignment rules\n\nUser Assignment Status:\n• PROVISIONED - User is provisioned and active in application\n• STAGED_FOR_PROVISIONING - User staged for provisioning\n• DEPROVISIONED - User removed from application\n• SUSPENDED - User temporarily suspended in application\n\nThis tool uses full pagination to return ALL assigned users, which may take longer\nfor applications with many users but ensures complete data for compliance and auditing.\n\nUse for application access reviews, user assignment audits, and troubleshooting\nuser access issues.', 'parameters': {'type': 'object', 'properties': {'app_id': {'type': 'string', 'title': 'App Id', 'description': 'The ID of the application'}}, 'required': ['app_id'], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'list_okta_applications', 'description': 'List all applications in the Okta organization with pagination and filtering.\n\nOAuth 2.0 scopes: okta.apps.read\n\nLists all apps in the org with pagination. A subset of apps can be returned that match \na supported filter expression or query. The results are paginated according to the \nlimit parameter. If there are multiple pages of results, the header contains a next link.\n\nNote: To list all of a member\'s assigned app links, use the List all assigned app \nlinks endpoint in the User Resources API.\n\nQuery Parameters:\n\nq (string): Searches for apps with name or label properties that starts with the q \nvalue using the startsWith operation.\nExample: q=Okta\n\nfilter (string): Filters apps by status, user.id, group.id, credentials.signing.kid \nor name expression that supports the eq operator.\n\nFilter Examples:\n• Filter for active apps: status eq "ACTIVE"\n• Filter for apps with specific name: name eq "okta_org2org"\n• Filter for apps using a specific key: credentials.signing.kid eq "SIMcCQNY3uwXoW3y0vf6VxiBb5n9pf8L2fK8d-F1bm4"\n• Filter by user assignment: user.id eq "00u1emaK22p5pX0123d7"\n• Filter by group assignment: group.id eq "00g1emaK22p5pX0123d7"\n\nlimit (integer): Specifies the number of results per page (max 200, default -1 for all)\n\nafter (string): Specifies the pagination cursor for the next page of results. \nTreat this as an opaque value obtained through the next link relationship.\n\nuse_optimization (boolean): Specifies whether to use query optimization. If true, \nthe response contains a subset of app instance properties for better performance.\n\ninclude_non_deleted (boolean): Specifies whether to include non-active, but not \ndeleted apps in the results.\n\nexpand (string): An optional parameter for link expansion to embed more resources \nin the response. Only supports expand=user/{userId} and must be used with the \nuser.id eq "{userId}" filter query for the same user.\n\nApplication Status Values:\n• ACTIVE - Application is active and available to users\n• INACTIVE - Application is disabled and not available\n\nCommon Sign-On Modes:\n• SAML_2_0, OPENID_CONNECT, SECURE_PASSWORD_STORE, AUTO_LOGIN\n• BOOKMARK, BASIC_AUTH, BROWSER_PLUGIN, WS_FEDERATION\n\nReturns application details including ID, name, label, status, and sign-on configuration.', 'parameters': {'type': 'object', 'properties': {'after': {'type': 'string', 'title': 'After', 'description': 'Pagination cursor for the next page of results', 'default': ''}, 'expand': {'type': 'string', 'title': 'Expand', 'description': 'Link expansion to embed more resources (supports expand=user/{userId})', 'default': ''}, 'filter': {'type': 'string', 'title': 'Filter', 'description': 'Filters apps by status, user.id, group.id, credentials.signing.kid or name', 'default': ''}, 'include_non_deleted': {'type': 'boolean', 'title': 'Include Non Deleted', 'description': 'Include non-active, but not deleted apps', 'default': False}, 'limit': {'type': 'integer', 'title': 'Limit', 'description': 'Maximum applications to return (1-200)', 'default': 50, 'minimum': 1, 'maximum': 200}, 'q': {'type': 'string', 'title': 'Q', 'description': 'Searches for apps with name or label properties that start with the q value', 'default': ''}, 'use_optimization': {'type': 'boolean', 'title': 'Use Optimization', 'description': 'Use query optimization for subset of app properties', 'default': False}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'list_okta_group_users', 'description': 'List all users in a specific Okta group with full pagination for complete results.\n\nReturns complete group membership including:\n• All users currently in the group\n• User profile information\n• Membership timestamps and details\n• User status and account information\n\nPagination Handling:\nThis tool automatically handles pagination to return ALL users in the group,\nnot just the first page. For large groups, this ensures complete membership visibility.\n\nUser Information Includes:\n• Basic user profile (name, email, username)\n• User status (ACTIVE, SUSPENDED, etc.)\n• User ID for further operations\n• Profile attributes relevant to group membership\n\nGroup Membership Details:\n• Current active memberships only\n• No historical membership data\n• Real-time membership status\n• Direct group membership (not inherited)\n\nPerformance Considerations:\n• Large groups may take longer to process\n• Automatic rate limiting to prevent API throttling\n• Progress reporting for long-running operations\n• Graceful handling of pagination errors\n\nCommon Use Cases:\n• Complete group membership audit\n• User access reviews and compliance\n• Group cleanup and optimization\n• Security group verification\n• Bulk user operations on group members', 'parameters': {'type': 'object', 'properties': {'group_id': {'type': 'string', 'title': 'Group Id', 'description': 'The ID of the group to list users for'}}, 'required': ['group_id'], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'list_okta_groups', 'description': 'List Okta groups with filtering - limited to 50 groups by default for context efficiency.\n\nIMPORTANT LIMITATIONS:\nLimited to 50 groups by default (max 100) to stay within LLM context limits.\nUse search filters to find specific groups rather than browsing all groups.\n\nSearch Parameters (priority order):\n1. search - SCIM filter syntax (recommended for precise filtering)\n2. query - Simple text search against group name\n3. filter_type - Basic type/status filtering\n\nSCIM Filter Syntax (search parameter):\nUses SCIM filter expressions for precise group filtering.\n\nSupported Operators:\n• eq (equals), ne (not equals), gt (greater than), lt (less than)\n• ge (greater than or equal), le (less than or equal)\n• sw (starts with), co (contains), pr (present)\n• and (logical AND), or (logical OR)\n\nCommon Group Profile Fields:\n• profile.name - Group name\n• profile.description - Group description\n• type - Group type (OKTA_GROUP, BUILT_IN, etc.)\n• created, lastUpdated, lastMembershipUpdated\n• Custom profile attributes\n\nExample SCIM Filters:\n• Engineering groups: \'profile.name co "Engineering"\'\n• Groups starting with Admin: \'profile.name sw "Admin"\'\n• Multiple departments: \'profile.name co "Engineering" or profile.name co "Sales"\'\n• Built-in groups: \'type eq "BUILT_IN"\'\n• Groups with descriptions: \'profile.description pr\'\n• Recent groups: \'created gt "2024-01-01T00:00:00.000Z"\'\n\nQuery Parameter:\nSimple text search that matches against group name.\nUse when you want broad matching without specific SCIM syntax.\n\nFilter Type Parameter:\nBasic filtering for type or status. Examples: \'type eq "OKTA_GROUP"\'\n\nGroup Types:\n• OKTA_GROUP - Standard Okta groups\n• BUILT_IN - System built-in groups (Everyone, etc.)\n• APP_GROUP - Application-specific groups\n\nCommon Use Cases:\n• Find department or team groups\n• Audit security and admin groups\n• Locate application-specific groups\n• Review group membership structures\n• Compliance and access reviews', 'parameters': {'type': 'object', 'properties': {'filter_type': {'type': 'string', 'title': 'Filter Type', 'description': 'Filter type (type, status, etc.)', 'default': ''}, 'max_results': {'type': 'integer', 'title': 'Max Results', 'description': 'Maximum groups to return (1-100). Limited for LLM context window.', 'default': 50}, 'query': {'type': 'string', 'title': 'Query', 'description': 'Simple text search matched against group name', 'default': ''}, 'search': {'type': 'string', 'title': 'Search', 'description': 'SCIM filter syntax - see docstring for complete syntax', 'default': ''}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'list_okta_network_zones', 'description': 'List all network zones defined in the Okta organization.\n\nReturns comprehensive network zone information including:\n• IP ranges and CIDR blocks\n• Dynamic zone definitions and criteria\n• Proxy configurations and settings\n• Zone status and activation state\n• Administrative metadata\n\nNetwork Zone Types:\n• IP - Static IP address ranges and CIDR blocks\n• DYNAMIC - Dynamic zones based on location or other criteria\n• BLOCKLIST - IP ranges to block or restrict\n• POLICY - Policy-specific network constraints\n\nZone Information Includes:\n• Zone identification (ID, name, type)\n• IP address ranges and gateway lists\n• Proxy and ASN configurations\n• Geographic location data\n• Usage and application assignments\n\nIP Zone Details:\n• Static IP ranges (CIDR notation)\n• Gateway IP addresses\n• Proxy IP configurations\n• ASN (Autonomous System Number) lists\n\nDynamic Zone Criteria:\n• Geographic locations and countries\n• ISP and carrier information\n• Risk assessment factors\n• Behavioral analysis inputs\n\nZone Status Information:\n• ACTIVE - Currently enforced zones\n• INACTIVE - Disabled or suspended zones\n• Usage statistics and policy assignments\n• Last modification timestamps\n\nFiltering Options:\n• By zone type (IP, DYNAMIC, etc.)\n• By status (ACTIVE, INACTIVE)\n• By administrative properties\n\nCommon Use Cases:\n• Network security policy review\n• IP allowlist and blocklist management\n• Geographic access control audit\n• Compliance and regulatory reporting\n• Network zone optimization', 'parameters': {'type': 'object', 'properties': {'filter_type': {'type': 'string', 'title': 'Filter Type', 'description': 'Filter zones by type (IP, DYNAMIC) or status (ACTIVE, INACTIVE)', 'default': ''}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'list_okta_policy_rules', 'description': 'List all rules for a specific Okta policy.\n\nReturns complete rule information including:\n• Rule conditions and criteria\n• Authentication requirements and methods\n• Network zone constraints and locations\n• User and group assignments\n• Actions and behaviors\n• Priority and status settings\n\nPolicy Rule Information:\n• Rule names and descriptions\n• Activation status (ACTIVE, INACTIVE)\n• Priority ordering within policy\n• Condition logic and expressions\n• Actions taken when rule matches\n\nCommon Rule Types:\n• Authentication policies (MFA requirements)\n• Authorization policies (access controls)\n• Password policies (complexity rules)\n• Sign-on policies (SSO behaviors)\n\nRule Conditions Include:\n• Network zones and IP ranges\n• User and group memberships\n• Application context\n• Device and platform requirements\n• Risk and context factors\n\nActions and Behaviors:\n• MFA factor requirements\n• Session management\n• Access grants/denials\n• Redirections and workflows\n\nCommon Use Cases:\n• Policy rule audit and review\n• Security compliance assessment\n• Troubleshoot access issues\n• Rule optimization and cleanup\n• Access control verification', 'parameters': {'type': 'object', 'properties': {'policy_id': {'type': 'string', 'title': 'Policy Id', 'description': 'The ID of the policy to list rules for'}}, 'required': ['policy_id'], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'list_okta_user_applications', 'description': 'List all application links (assigned applications) for a specific Okta user.', 'parameters': {'type': 'object', 'properties': {'show_all': {'type': 'boolean', 'title': 'Show All', 'description': 'If True, shows all app links; if False, only shows app links assigned directly to the user', 'default': True}, 'user_id': {'type': 'string', 'title': 'User Id', 'description': 'The ID or login of the user to retrieve applications for'}}, 'required': ['user_id'], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'list_okta_user_factors', 'description': 'List all authentication factors enrolled for a specific Okta user.', 'parameters': {'type': 'object', 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'The ID or login of the user to retrieve authentication factors for'}}, 'required': ['user_id'], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'list_okta_user_groups', 'description': 'List all groups that a specific Okta user belongs to.', 'parameters': {'type': 'object', 'properties': {'user_id': {'type': 'string', 'title': 'User Id', 'description': 'The ID or login of the user to retrieve groups for'}}, 'required': ['user_id'], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'list_okta_users', 'description': 'List Okta users with filtering - returns first 50 users by default due to LLM context limitations.\n\nIMPORTANT: This tool returns only the first 50 users by default (max 100) to stay within LLM context limits.\nUse specific search filters to find the users you need rather than browsing all users.\n\nsearch (Recommended, Powerful):\nUses flexible SCIM filter syntax for precise filtering.\nSupports operators: eq, ne, gt, lt, ge, le, sw (starts with), co (contains), pr (present), and, or.\nFilters on most user properties, including custom attributes, id, status, dates, arrays.\nSupports sorting (sortBy, sortOrder) - NOTE: Sorting parameters ONLY work with \'search\' parameter, not with \'query\'.\n\nExamples:\n- Active engineering users: search=\'profile.department eq "Engineering" and status eq "ACTIVE"\'\n- Users with first name starting with A: search=\'profile.firstName sw "A"\'\n- Users in SF or London: search=\'profile.city eq "San Francisco" or profile.city eq "London"\'\n- Sorted results: search=\'status eq "ACTIVE"\', sort_by=\'profile.lastName\', sort_order=\'asc\'\n- Custom attribute search: search=\'profile.employeeNumber eq "12345"\'', 'parameters': {'type': 'object', 'properties': {'filter_type': {'type': 'string', 'title': 'Filter Type', 'description': 'Filter type (status, type, etc.)', 'default': ''}, 'max_results': {'type': 'integer', 'title': 'Max Results', 'description': 'Maximum users to return (1-100). Limited for LLM context window.', 'default': 50}, 'query': {'type': 'string', 'title': 'Query', 'description': 'Simple text search matched against firstName, lastName, or email', 'default': ''}, 'search': {'type': 'string', 'title': 'Search', 'description': 'SCIM filter syntax like - profile.firstName eq "Dan"', 'default': ''}, 'sort_by': {'type': 'string', 'title': 'Sort By', 'description': "Field to sort by (only works with 'search' parameter)", 'default': 'created'}, 'sort_order': {'type': 'string', 'title': 'Sort Order', 'description': "Sort direction (asc or desc) (only works with 'search' parameter)", 'default': 'desc'}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
okta-mcp-fctr
|
other
|
{'type': 'function', 'name': 'parse_relative_time', 'description': 'Parse natural language time expressions into Okta API-compatible timestamps.\n\nConverts human-readable time expressions into ISO 8601 formatted timestamps\nwith microseconds, suitable for Okta API queries and filtering.\n\nSupported Expressions:\n• Relative times: "2 days ago", "1 week ago", "3 months ago"\n• Named times: "yesterday", "last week", "last month" \n• Precise times: "1 hour ago", "30 minutes ago"\n• Period boundaries: "beginning of today", "end of yesterday"\n• Week/month boundaries: "start of this week", "end of last month"\n\nOutput Format:\nReturns timestamp in format: YYYY-MM-DDTHH:MM:SS.ffffffZ\nExample: 2024-06-21T00:00:00.000000Z\n\nCommon Use Cases:\n• Log queries: \'since=parse_relative_time("24 hours ago")\'\n• User filters: \'lastUpdated gt parse_relative_time("1 week ago")\'\n• Application activity: \'created after parse_relative_time("yesterday")\'\n• Policy rule conditions with time-based criteria\n\nPerfect for constructing Okta audit queries and date-based filters:\nExample: filter=\'eventType eq "user.authentication.auth" and published gt "parsed_timestamp"\'', 'parameters': {'type': 'object', 'properties': {'time_expression': {'type': 'string', 'title': 'Time Expression', 'description': 'Natural language time expression'}}, 'required': ['time_expression'], 'additionalProperties': False}, 'strict': True}
|
omi
|
other
|
{'type': 'function', 'name': 'create_memory', 'description': 'Create a new memory. A memory is a known fact about the user across multiple domains.', 'parameters': {'type': 'object', 'properties': {'api_key': {'title': 'Api Key', 'description': "The user's MCP API key. If not provided, it will be read from the OMI_API_KEY environment variable. For more details, see https://docs.omi.me/doc/developer/MCP", 'default': None, 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'category': {'$ref': '#/$defs/MemoryCategory', 'description': 'The category of the memory to create.'}, 'content': {'type': 'string', 'title': 'Content', 'description': 'The content of the memory.'}}, 'required': ['content', 'category'], 'additionalProperties': False}, 'strict': True}
|
omi
|
other
|
{'type': 'function', 'name': 'delete_memory', 'description': 'Delete a memory by ID. A memory is a known fact about the user across multiple domains.', 'parameters': {'type': 'object', 'properties': {'api_key': {'title': 'Api Key', 'description': "The user's MCP API key. If not provided, it will be read from the OMI_API_KEY environment variable. For more details, see https://docs.omi.me/doc/developer/MCP", 'default': None, 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'memory_id': {'type': 'string', 'title': 'Memory Id', 'description': 'The ID of the memory to delete.'}}, 'required': ['memory_id'], 'additionalProperties': False}, 'strict': True}
|
omi
|
other
|
{'type': 'function', 'name': 'edit_memory', 'description': "Edit a memory's content. A memory is a known fact about the user across multiple domains.", 'parameters': {'type': 'object', 'properties': {'api_key': {'title': 'Api Key', 'description': "The user's MCP API key. If not provided, it will be read from the OMI_API_KEY environment variable. For more details, see https://docs.omi.me/doc/developer/MCP", 'default': None, 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'content': {'type': 'string', 'title': 'Content', 'description': 'The new content for the memory.'}, 'memory_id': {'type': 'string', 'title': 'Memory Id', 'description': 'The ID of the memory to edit.'}}, 'required': ['memory_id', 'content'], 'additionalProperties': False}, 'strict': True}
|
omi
|
other
|
{'type': 'function', 'name': 'get_conversation_by_id', 'description': 'Retrieve a conversation by ID including each segment of the transcript.', 'parameters': {'type': 'object', 'properties': {'api_key': {'title': 'Api Key', 'description': "The user's MCP API key. If not provided, it will be read from the OMI_API_KEY environment variable. For more details, see https://docs.omi.me/doc/developer/MCP", 'default': None, 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'conversation_id': {'type': 'string', 'title': 'Conversation Id', 'description': 'The ID of the conversation to retrieve.'}}, 'required': ['conversation_id'], 'additionalProperties': False}, 'strict': True}
|
omi
|
other
|
{'type': 'function', 'name': 'get_conversations', 'description': 'Retrieve a list of conversation metadata. To get full transcripts, use get_conversation_by_id.', 'parameters': {'type': 'object', 'properties': {'api_key': {'title': 'Api Key', 'description': "The user's MCP API key. If not provided, it will be read from the OMI_API_KEY environment variable. For more details, see https://docs.omi.me/doc/developer/MCP", 'default': None, 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'categories': {'type': 'array', 'title': 'Categories', 'description': 'Filter by conversation categories.', 'default': [], 'items': {'$ref': '#/$defs/ConversationCategory'}}, 'end_date': {'title': 'End Date', 'description': 'Filter conversations before this date (yyyy-mm-dd)', 'default': None, 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'limit': {'type': 'integer', 'title': 'Limit', 'description': 'The number of conversations to retrieve.', 'default': 20}, 'offset': {'type': 'integer', 'title': 'Offset', 'description': 'The offset of the conversations to retrieve.', 'default': 0}, 'start_date': {'title': 'Start Date', 'description': 'Filter conversations after this date (yyyy-mm-dd)', 'default': None, 'anyOf': [{'type': 'string'}, {'type': 'null'}]}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
omi
|
other
|
{'type': 'function', 'name': 'get_memories', 'description': 'Retrieve a list of memories. A memory is a known fact about the user across multiple domains.', 'parameters': {'type': 'object', 'properties': {'api_key': {'title': 'Api Key', 'description': "The user's MCP API key. If not provided, it will be read from the OMI_API_KEY environment variable. For more details, see https://docs.omi.me/doc/developer/MCP", 'default': None, 'anyOf': [{'type': 'string'}, {'type': 'null'}]}, 'categories': {'type': 'array', 'title': 'Categories', 'description': 'The categories of memories to filter by.', 'default': [], 'items': {'$ref': '#/$defs/MemoryCategory'}}, 'limit': {'type': 'integer', 'title': 'Limit', 'description': 'The number of memories to retrieve.', 'default': 100}, 'offset': {'type': 'integer', 'title': 'Offset', 'description': 'The offset of the memories to retrieve.', 'default': 0}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'archive_room', 'description': 'Archive a room.', 'parameters': {'type': 'object', 'properties': {'roomId': {'type': 'number', 'description': 'The ID of the room to archive.'}}, 'required': ['roomId'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'copy_batch_items', 'description': 'Copy to a folder.', 'parameters': {'type': 'object', 'properties': {'destFolderId': {'description': 'The ID of the destination folder to copy the items to.'}, 'fileIds': {'type': 'array', 'description': 'The IDs of the files to copy.', 'items': True}, 'folderIds': {'type': 'array', 'description': 'The IDs of the folders to copy.', 'items': True}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'create_folder', 'description': 'Create a folder.', 'parameters': {'type': 'object', 'properties': {'filters': {'type': 'object', 'description': 'The filters to apply to the folder creation. Use them to reduce the size of the response.', 'required': ['fields'], 'properties': {'fields': {'type': 'array', 'items': {'type': 'string', 'description': 'The fields to include in the response.\n\nid - The file entry ID.\nrootFolderId - The root folder ID of the file entry.\ncanShare - Specifies if the file entry can be shared or not.\nsecurity - The actions that can be performed with the file entry.\ntitle - The file entry title.\naccess - The access rights to the file entry.\nshared - Specifies if the file entry is shared or not.\ncreated.utcTime - The time in UTC format.\ncreatedBy.id - The user ID.\ncreatedBy.displayName - The user display name.\ncreatedBy.isAnonim - Specifies if the user is anonymous or not.\nfileEntryType - The file entry type.\nparentId - The parent folder ID of the folder.\nfilesCount - The number of files that the folder contains.\nfoldersCount - The number of folders that the folder contains.\nisShareable - Specifies if the folder can be shared or not.\nisFavorite - Specifies if the folder is favorite or not.\ntags - The list of tags of the folder.\nroomType - The room type of the folder.\nprivate - Specifies if the folder is private or not.\ntype - The folder type.\ninRoom - Specifies if the folder is placed in the room or not.', 'enum': ['id', 'rootFolderId', 'canShare', 'security', 'title', 'access', 'shared', 'created.utcTime', 'createdBy.id', 'createdBy.displayName', 'createdBy.isAnonim', 'fileEntryType', 'parentId', 'filesCount', 'foldersCount', 'isShareable', 'isFavorite', 'tags', 'roomType', 'private', 'type', 'inRoom']}}}, 'additionalProperties': False}, 'parentId': {'type': 'number', 'description': 'The ID of the room or folder to create the folder in.'}, 'title': {'type': 'string', 'description': 'The title of the folder to create.'}}, 'required': ['parentId', 'title', 'filters'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'create_room', 'description': 'Create a room.', 'parameters': {'type': 'object', 'properties': {'filters': {'type': 'object', 'description': 'The filters to apply to the room creation.', 'required': ['fields'], 'properties': {'fields': {'type': 'array', 'items': {'type': 'string', 'description': 'The fields to include in the response.\n\nid - The file entry ID.\nrootFolderId - The root folder ID of the file entry.\ncanShare - Specifies if the file entry can be shared or not.\nsecurity - The actions that can be performed with the file entry.\ntitle - The file entry title.\naccess - The access rights to the file entry.\nshared - Specifies if the file entry is shared or not.\ncreated.utcTime - The time in UTC format.\ncreatedBy.id - The user ID.\ncreatedBy.displayName - The user display name.\ncreatedBy.isAnonim - Specifies if the user is anonymous or not.\nfileEntryType - The file entry type.\nparentId - The parent folder ID of the folder.\nfilesCount - The number of files that the folder contains.\nfoldersCount - The number of folders that the folder contains.\nisShareable - Specifies if the folder can be shared or not.\nisFavorite - Specifies if the folder is favorite or not.\ntags - The list of tags of the folder.\nroomType - The room type of the folder.\nprivate - Specifies if the folder is private or not.\ntype - The folder type.\ninRoom - Specifies if the folder is placed in the room or not.', 'enum': ['id', 'rootFolderId', 'canShare', 'security', 'title', 'access', 'shared', 'created.utcTime', 'createdBy.id', 'createdBy.displayName', 'createdBy.isAnonim', 'fileEntryType', 'parentId', 'filesCount', 'foldersCount', 'isShareable', 'isFavorite', 'tags', 'roomType', 'private', 'type', 'inRoom']}}}, 'additionalProperties': False}, 'roomType': {'type': 'number', 'description': 'The type of the room to create.\n\n1 - Form Filling Room. Upload PDF forms into the room. Invite members and guests to fill out a PDF form. Review completed forms and analyze data automatically collected in a spreadsheet.\n2 - Collaboration room. Collaborate on one or multiple documents with your team.\n5 - Custom room. Apply your own settings to use this room for any custom purpose.\n6 - Public room. Share documents for viewing, editing, commenting, or reviewing without registration. You can also embed this room into any web interface.\n8 - Virtual Data Room. Use VDR for advanced file security and transparency. Set watermarks, automatically index and track all content, restrict downloading and copying.', 'default': 6, 'enum': [1, 2, 5, 6, 8]}, 'title': {'type': 'string', 'description': 'The title of the room to create.'}}, 'required': ['title', 'filters'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'delete_file', 'description': 'Delete a file.', 'parameters': {'type': 'object', 'properties': {'fileId': {'type': 'number', 'description': 'The ID of the file to delete.'}}, 'required': ['fileId'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'delete_folder', 'description': 'Delete a folder.', 'parameters': {'type': 'object', 'properties': {'folderId': {'type': 'number', 'description': 'The ID of the folder to delete.'}}, 'required': ['folderId'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'download_file_as_text', 'description': 'Download a file as text.', 'parameters': {'type': 'object', 'properties': {'fileId': {'type': 'number', 'description': 'The ID of the file to download as text.'}}, 'required': ['fileId'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'get_all_people', 'description': 'Get all people.', 'parameters': {'type': 'object', 'properties': {'filters': {'type': 'object', 'description': 'The filters to apply to the list of people. Use them to reduce the size of the response.', 'required': ['fields'], 'properties': {'count': {'type': 'number', 'description': 'The maximum number of items to be retrieved in the response.', 'default': 30, 'minimum': 1, 'maximum': 50}, 'fields': {'type': 'array', 'items': {'type': 'string', 'description': 'The fields to include in the response.\n\nid - The user ID.\ndisplayName - The user display name.\nisAnonim - Specifies if the user is anonymous or not.\nemail - The user email.\nbirthday.utcTime - The time in UTC format.\nstatus - The user status.\ndepartment - The user department.\nisAdmin - Specifies if the user is an administrator or not.\nisRoomAdmin - Specifies if the user is a room administrator or not.\nisOwner - Specifies if the user is a portal owner or not.\nisVisitor - Specifies if the user is a portal visitor or not.\nisCollaborator - Specifies if the user is a portal collaborator or not.', 'enum': ['id', 'displayName', 'isAnonim', 'email', 'birthday.utcTime', 'status', 'department', 'isAdmin', 'isRoomAdmin', 'isOwner', 'isVisitor', 'isCollaborator']}}, 'filterBy': {'type': 'string', 'description': 'Specifies the filter criteria for user-related queries.'}, 'filterSeparator': {'type': 'string', 'description': 'The character or string used to separate multiple filter values in a filtering query.'}, 'filterValue': {'type': 'string', 'description': 'The text value used as an additional filter criterion for profiles retrieval.'}, 'sortBy': {'type': 'string', 'description': 'Specifies the property or field name by which the results should be sorted.'}, 'sortOrder': {'type': 'number', 'description': 'The order in which the results are sorted.\n\n0 - Ascending order\n1 - Descending order', 'enum': [0, 1]}, 'startIndex': {'type': 'number', 'description': 'The zero-based index of the first item to be retrieved in a filtered result set.'}}, 'additionalProperties': False}}, 'required': ['filters'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'get_file_info', 'description': 'Get file information.', 'parameters': {'type': 'object', 'properties': {'fileId': {'type': 'number', 'description': 'The ID of the file to get info for.'}, 'filters': {'type': 'object', 'description': 'The filters to apply to the file info. Use them to reduce the size of the response.', 'required': ['fields'], 'properties': {'fields': {'type': 'array', 'items': {'type': 'string', 'description': 'The fields to include in the response.\n\nid - The file entry ID.\nrootFolderId - The root folder ID of the file entry.\ncanShare - Specifies if the file entry can be shared or not.\nsecurity - The actions that can be performed with the file entry.\ntitle - The file entry title.\naccess - The access rights to the file entry.\nshared - Specifies if the file entry is shared or not.\ncreated.utcTime - The time in UTC format.\ncreatedBy.id - The user ID.\ncreatedBy.displayName - The user display name.\ncreatedBy.isAnonim - Specifies if the user is anonymous or not.\nfileEntryType - The file entry type.\nfolderId - The folder ID where the file is located.\nfileType - The file type.\nfileExst - The file extension.\ncomment - The comment to the file.\nencrypted - Specifies if the file is encrypted or not.\nlocked - Specifies if the file is locked or not.', 'enum': ['id', 'rootFolderId', 'canShare', 'security', 'title', 'access', 'shared', 'created.utcTime', 'createdBy.id', 'createdBy.displayName', 'createdBy.isAnonim', 'fileEntryType', 'folderId', 'fileType', 'fileExst', 'comment', 'encrypted', 'locked']}}}, 'additionalProperties': False}}, 'required': ['fileId', 'filters'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'get_folder_content', 'description': 'Get content of a folder.', 'parameters': {'type': 'object', 'properties': {'filters': {'type': 'object', 'description': 'The filters to apply to the contents of the folder. Use them to reduce the size of the response.', 'required': ['fields'], 'properties': {'applyFilterOption': {'type': 'string', 'description': 'Specifies whether to return only files, only folders or all elements from the specified folder.', 'enum': ['All', 'Files', 'Folders']}, 'count': {'type': 'number', 'description': 'The maximum number of items to retrieve in the request.', 'default': 30, 'minimum': 1, 'maximum': 50}, 'excludeSubject': {'type': 'boolean', 'description': 'Specifies whether to exclude search by user or group ID.'}, 'extension': {'type': 'string', 'description': 'Specifies whether to search for the specific file extension.'}, 'fields': {'type': 'array', 'items': {'type': 'string', 'description': 'The fields to include in the response.\n\nfiles.id - The file entry ID.\nfiles.rootFolderId - The root folder ID of the file entry.\nfiles.canShare - Specifies if the file entry can be shared or not.\nfiles.security - The actions that can be performed with the file entry.\nfiles.title - The file entry title.\nfiles.access - The access rights to the file entry.\nfiles.shared - Specifies if the file entry is shared or not.\nfiles.created.utcTime - The time in UTC format.\nfiles.createdBy.id - The user ID.\nfiles.createdBy.displayName - The user display name.\nfiles.createdBy.isAnonim - Specifies if the user is anonymous or not.\nfiles.fileEntryType - The file entry type.\nfiles.folderId - The folder ID where the file is located.\nfiles.fileType - The file type.\nfiles.fileExst - The file extension.\nfiles.comment - The comment to the file.\nfiles.encrypted - Specifies if the file is encrypted or not.\nfiles.locked - Specifies if the file is locked or not.\nfolders.id - The file entry ID.\nfolders.rootFolderId - The root folder ID of the file entry.\nfolders.canShare - Specifies if the file entry can be shared or not.\nfolders.security - The actions that can be performed with the file entry.\nfolders.title - The file entry title.\nfolders.access - The access rights to the file entry.\nfolders.shared - Specifies if the file entry is shared or not.\nfolders.created.utcTime - The time in UTC format.\nfolders.createdBy.id - The user ID.\nfolders.createdBy.displayName - The user display name.\nfolders.createdBy.isAnonim - Specifies if the user is anonymous or not.\nfolders.fileEntryType - The file entry type.\nfolders.parentId - The parent folder ID of the folder.\nfolders.filesCount - The number of files that the folder contains.\nfolders.foldersCount - The number of folders that the folder contains.\nfolders.isShareable - Specifies if the folder can be shared or not.\nfolders.isFavorite - Specifies if the folder is favorite or not.\nfolders.tags - The list of tags of the folder.\nfolders.roomType - The room type of the folder.\nfolders.private - Specifies if the folder is private or not.\nfolders.type - The folder type.\nfolders.inRoom - Specifies if the folder is placed in the room or not.\ncurrent.id - The file entry ID.\ncurrent.rootFolderId - The root folder ID of the file entry.\ncurrent.canShare - Specifies if the file entry can be shared or not.\ncurrent.security - The actions that can be performed with the file entry.\ncurrent.title - The file entry title.\ncurrent.access - The access rights to the file entry.\ncurrent.shared - Specifies if the file entry is shared or not.\ncurrent.created.utcTime - The time in UTC format.\ncurrent.createdBy.id - The user ID.\ncurrent.createdBy.displayName - The user display name.\ncurrent.createdBy.isAnonim - Specifies if the user is anonymous or not.\ncurrent.fileEntryType - The file entry type.\ncurrent.parentId - The parent folder ID of the folder.\ncurrent.filesCount - The number of files that the folder contains.\ncurrent.foldersCount - The number of folders that the folder contains.\ncurrent.isShareable - Specifies if the folder can be shared or not.\ncurrent.isFavorite - Specifies if the folder is favorite or not.\ncurrent.tags - The list of tags of the folder.\ncurrent.roomType - The room type of the folder.\ncurrent.private - Specifies if the folder is private or not.\ncurrent.type - The folder type.\ncurrent.inRoom - Specifies if the folder is placed in the room or not.\nstartIndex - The folder start index.\ncount - The number of folder elements.\ntotal - The total number of elements in the folder.', 'enum': ['files.id', 'files.rootFolderId', 'files.canShare', 'files.security', 'files.title', 'files.access', 'files.shared', 'files.created.utcTime', 'files.createdBy.id', 'files.createdBy.displayName', 'files.createdBy.isAnonim', 'files.fileEntryType', 'files.folderId', 'files.fileType', 'files.fileExst', 'files.comment', 'files.encrypted', 'files.locked', 'folders.id', 'folders.rootFolderId', 'folders.canShare', 'folders.security', 'folders.title', 'folders.access', 'folders.shared', 'folders.created.utcTime', 'folders.createdBy.id', 'folders.createdBy.displayName', 'folders.createdBy.isAnonim', 'folders.fileEntryType', 'folders.parentId', 'folders.filesCount', 'folders.foldersCount', 'folders.isShareable', 'folders.isFavorite', 'folders.tags', 'folders.roomType', 'folders.private', 'folders.type', 'folders.inRoom', 'current.id', 'current.rootFolderId', 'current.canShare', 'current.security', 'current.title', 'current.access', 'current.shared', 'current.created.utcTime', 'current.createdBy.id', 'current.createdBy.displayName', 'current.createdBy.isAnonim', 'current.fileEntryType', 'current.parentId', 'current.filesCount', 'current.foldersCount', 'current.isShareable', 'current.isFavorite', 'current.tags', 'current.roomType', 'current.private', 'current.type', 'current.inRoom', 'startIndex', 'count', 'total']}}, 'filterType': {'type': 'number', 'description': 'The filter type.\n\n0 - None\n1 - Files only\n2 - Folders only\n3 - Documents only\n4 - Presentations only\n5 - Spreadsheets only\n7 - Images only\n8 - By user\n9 - By department\n10 - Archive only\n11 - By extension\n12 - Media only\n13 - Filling forms rooms\n14 - Editing rooms\n17 - Custom rooms\n20 - Public rooms\n22 - Pdf\n23 - Pdf form\n24 - Virtual data rooms', 'enum': [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 17, 20, 22, 23, 24]}, 'filterValue': {'type': 'string', 'description': 'The text value used as a filter parameter for folder queries.'}, 'roomId': {'type': 'number', 'description': 'The room ID.'}, 'searchArea': {'type': 'string', 'description': 'The search area.', 'enum': ['Active', 'Archive', 'Any', 'RecentByLinks', 'Template']}, 'sortBy': {'type': 'string', 'description': 'Specifies the property used for sorting the folder request results.'}, 'sortOrder': {'type': 'number', 'description': 'The order in which the results are sorted.\n\n0 - Ascending order\n1 - Descending order', 'enum': [0, 1]}, 'startIndex': {'type': 'number', 'description': 'The zero-based index of the first item to retrieve in a paginated request.'}, 'userIdOrGroupId': {'type': 'string', 'description': 'The user or group ID.', 'format': 'uuid'}}, 'additionalProperties': False}, 'folderId': {'type': 'number', 'description': 'The ID of the folder to get.'}}, 'required': ['folderId', 'filters'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'get_folder_info', 'description': 'Get folder information.', 'parameters': {'type': 'object', 'properties': {'filters': {'type': 'object', 'description': 'The filters to apply to the folder info. Use them to reduce the size of the response.', 'required': ['fields'], 'properties': {'fields': {'type': 'array', 'items': {'type': 'string', 'description': 'The fields to include in the response.\n\nid - The file entry ID.\nrootFolderId - The root folder ID of the file entry.\ncanShare - Specifies if the file entry can be shared or not.\nsecurity - The actions that can be performed with the file entry.\ntitle - The file entry title.\naccess - The access rights to the file entry.\nshared - Specifies if the file entry is shared or not.\ncreated.utcTime - The time in UTC format.\ncreatedBy.id - The user ID.\ncreatedBy.displayName - The user display name.\ncreatedBy.isAnonim - Specifies if the user is anonymous or not.\nfileEntryType - The file entry type.\nparentId - The parent folder ID of the folder.\nfilesCount - The number of files that the folder contains.\nfoldersCount - The number of folders that the folder contains.\nisShareable - Specifies if the folder can be shared or not.\nisFavorite - Specifies if the folder is favorite or not.\ntags - The list of tags of the folder.\nroomType - The room type of the folder.\nprivate - Specifies if the folder is private or not.\ntype - The folder type.\ninRoom - Specifies if the folder is placed in the room or not.', 'enum': ['id', 'rootFolderId', 'canShare', 'security', 'title', 'access', 'shared', 'created.utcTime', 'createdBy.id', 'createdBy.displayName', 'createdBy.isAnonim', 'fileEntryType', 'parentId', 'filesCount', 'foldersCount', 'isShareable', 'isFavorite', 'tags', 'roomType', 'private', 'type', 'inRoom']}}}, 'additionalProperties': False}, 'folderId': {'type': 'number', 'description': 'The ID of the folder to get info for.'}}, 'required': ['folderId', 'filters'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'get_my_folder', 'description': "Get the 'My Documents' folder.", 'parameters': {'type': 'object', 'properties': {'filters': {'type': 'object', 'description': 'The filters to apply to the My Documents folder. Use them to reduce the size of the response.', 'required': ['fields'], 'properties': {'applyFilterOption': {'type': 'string', 'description': 'Specifies whether to return only files, only folders or all elements.', 'enum': ['All', 'Files', 'Folders']}, 'count': {'type': 'number', 'description': 'The maximum number of items to retrieve in the response.', 'default': 30, 'minimum': 1, 'maximum': 50}, 'fields': {'type': 'array', 'items': {'type': 'string', 'description': 'The fields to include in the response.\n\nfiles.id - The file entry ID.\nfiles.rootFolderId - The root folder ID of the file entry.\nfiles.canShare - Specifies if the file entry can be shared or not.\nfiles.security - The actions that can be performed with the file entry.\nfiles.title - The file entry title.\nfiles.access - The access rights to the file entry.\nfiles.shared - Specifies if the file entry is shared or not.\nfiles.created.utcTime - The time in UTC format.\nfiles.createdBy.id - The user ID.\nfiles.createdBy.displayName - The user display name.\nfiles.createdBy.isAnonim - Specifies if the user is anonymous or not.\nfiles.fileEntryType - The file entry type.\nfiles.folderId - The folder ID where the file is located.\nfiles.fileType - The file type.\nfiles.fileExst - The file extension.\nfiles.comment - The comment to the file.\nfiles.encrypted - Specifies if the file is encrypted or not.\nfiles.locked - Specifies if the file is locked or not.\nfolders.id - The file entry ID.\nfolders.rootFolderId - The root folder ID of the file entry.\nfolders.canShare - Specifies if the file entry can be shared or not.\nfolders.security - The actions that can be performed with the file entry.\nfolders.title - The file entry title.\nfolders.access - The access rights to the file entry.\nfolders.shared - Specifies if the file entry is shared or not.\nfolders.created.utcTime - The time in UTC format.\nfolders.createdBy.id - The user ID.\nfolders.createdBy.displayName - The user display name.\nfolders.createdBy.isAnonim - Specifies if the user is anonymous or not.\nfolders.fileEntryType - The file entry type.\nfolders.parentId - The parent folder ID of the folder.\nfolders.filesCount - The number of files that the folder contains.\nfolders.foldersCount - The number of folders that the folder contains.\nfolders.isShareable - Specifies if the folder can be shared or not.\nfolders.isFavorite - Specifies if the folder is favorite or not.\nfolders.tags - The list of tags of the folder.\nfolders.roomType - The room type of the folder.\nfolders.private - Specifies if the folder is private or not.\nfolders.type - The folder type.\nfolders.inRoom - Specifies if the folder is placed in the room or not.\ncurrent.id - The file entry ID.\ncurrent.rootFolderId - The root folder ID of the file entry.\ncurrent.canShare - Specifies if the file entry can be shared or not.\ncurrent.security - The actions that can be performed with the file entry.\ncurrent.title - The file entry title.\ncurrent.access - The access rights to the file entry.\ncurrent.shared - Specifies if the file entry is shared or not.\ncurrent.created.utcTime - The time in UTC format.\ncurrent.createdBy.id - The user ID.\ncurrent.createdBy.displayName - The user display name.\ncurrent.createdBy.isAnonim - Specifies if the user is anonymous or not.\ncurrent.fileEntryType - The file entry type.\ncurrent.parentId - The parent folder ID of the folder.\ncurrent.filesCount - The number of files that the folder contains.\ncurrent.foldersCount - The number of folders that the folder contains.\ncurrent.isShareable - Specifies if the folder can be shared or not.\ncurrent.isFavorite - Specifies if the folder is favorite or not.\ncurrent.tags - The list of tags of the folder.\ncurrent.roomType - The room type of the folder.\ncurrent.private - Specifies if the folder is private or not.\ncurrent.type - The folder type.\ncurrent.inRoom - Specifies if the folder is placed in the room or not.\nstartIndex - The folder start index.\ncount - The number of folder elements.\ntotal - The total number of elements in the folder.', 'enum': ['files.id', 'files.rootFolderId', 'files.canShare', 'files.security', 'files.title', 'files.access', 'files.shared', 'files.created.utcTime', 'files.createdBy.id', 'files.createdBy.displayName', 'files.createdBy.isAnonim', 'files.fileEntryType', 'files.folderId', 'files.fileType', 'files.fileExst', 'files.comment', 'files.encrypted', 'files.locked', 'folders.id', 'folders.rootFolderId', 'folders.canShare', 'folders.security', 'folders.title', 'folders.access', 'folders.shared', 'folders.created.utcTime', 'folders.createdBy.id', 'folders.createdBy.displayName', 'folders.createdBy.isAnonim', 'folders.fileEntryType', 'folders.parentId', 'folders.filesCount', 'folders.foldersCount', 'folders.isShareable', 'folders.isFavorite', 'folders.tags', 'folders.roomType', 'folders.private', 'folders.type', 'folders.inRoom', 'current.id', 'current.rootFolderId', 'current.canShare', 'current.security', 'current.title', 'current.access', 'current.shared', 'current.created.utcTime', 'current.createdBy.id', 'current.createdBy.displayName', 'current.createdBy.isAnonim', 'current.fileEntryType', 'current.parentId', 'current.filesCount', 'current.foldersCount', 'current.isShareable', 'current.isFavorite', 'current.tags', 'current.roomType', 'current.private', 'current.type', 'current.inRoom', 'startIndex', 'count', 'total']}}, 'filterType': {'type': 'number', 'description': 'The filter type.\n\n0 - None\n1 - Files only\n2 - Folders only\n3 - Documents only\n4 - Presentations only\n5 - Spreadsheets only\n7 - Images only\n8 - By user\n9 - By department\n10 - Archive only\n11 - By extension\n12 - Media only\n13 - Filling forms rooms\n14 - Editing rooms\n17 - Custom rooms\n20 - Public rooms\n22 - Pdf\n23 - Pdf form\n24 - Virtual data rooms', 'enum': [0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, 12, 13, 14, 17, 20, 22, 23, 24]}, 'filterValue': {'type': 'string', 'description': 'The text used for filtering or searching folder contents.'}, 'sortBy': {'type': 'string', 'description': 'The property used to specify the sorting criteria for folder contents.'}, 'sortOrder': {'type': 'number', 'description': 'The order in which the results are sorted.\n\n0 - Ascending order\n1 - Descending order', 'enum': [0, 1]}, 'startIndex': {'type': 'number', 'description': 'The starting position of the items to be retrieved.'}, 'userIdOrGroupId': {'type': 'string', 'description': 'The user or group ID.', 'format': 'uuid'}}, 'additionalProperties': False}}, 'required': ['filters'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'get_room_access_levels', 'description': 'Get a list of available room invitation access levels.', 'parameters': {'type': 'object', 'properties': {'roomId': {'type': 'number', 'description': 'The ID of the room to get the invitation access for.'}}, 'required': ['roomId'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'get_room_info', 'description': 'Get room information.', 'parameters': {'type': 'object', 'properties': {'filters': {'type': 'object', 'description': 'The filters to apply to the room info.', 'required': ['fields'], 'properties': {'fields': {'type': 'array', 'items': {'type': 'string', 'description': 'The fields to include in the response.\n\nid - The file entry ID.\nrootFolderId - The root folder ID of the file entry.\ncanShare - Specifies if the file entry can be shared or not.\nsecurity - The actions that can be performed with the file entry.\ntitle - The file entry title.\naccess - The access rights to the file entry.\nshared - Specifies if the file entry is shared or not.\ncreated.utcTime - The time in UTC format.\ncreatedBy.id - The user ID.\ncreatedBy.displayName - The user display name.\ncreatedBy.isAnonim - Specifies if the user is anonymous or not.\nfileEntryType - The file entry type.\nparentId - The parent folder ID of the folder.\nfilesCount - The number of files that the folder contains.\nfoldersCount - The number of folders that the folder contains.\nisShareable - Specifies if the folder can be shared or not.\nisFavorite - Specifies if the folder is favorite or not.\ntags - The list of tags of the folder.\nroomType - The room type of the folder.\nprivate - Specifies if the folder is private or not.\ntype - The folder type.\ninRoom - Specifies if the folder is placed in the room or not.', 'enum': ['id', 'rootFolderId', 'canShare', 'security', 'title', 'access', 'shared', 'created.utcTime', 'createdBy.id', 'createdBy.displayName', 'createdBy.isAnonim', 'fileEntryType', 'parentId', 'filesCount', 'foldersCount', 'isShareable', 'isFavorite', 'tags', 'roomType', 'private', 'type', 'inRoom']}}}, 'additionalProperties': False}, 'roomId': {'type': 'number', 'description': 'The ID of the room to get info for.'}}, 'required': ['roomId', 'filters'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'get_room_security_info', 'description': 'Get a list of users with their access levels to a room.', 'parameters': {'type': 'object', 'properties': {'filters': {'type': 'object', 'description': 'The filters to apply to the room security info.', 'required': ['fields'], 'properties': {'count': {'type': 'number', 'description': 'The number of items to be retrieved or processed.', 'default': 30, 'minimum': 1, 'maximum': 50}, 'fields': {'type': 'array', 'items': {'type': 'string', 'description': 'The fields to include in the response.\n\nmembers.access - The access rights type.\nmembers.sharedTo - The user who has the access to the specified file.\nmembers.isLocked - Specifies if the access right is locked or not.\nmembers.isOwner - Specifies if the user is an owner of the specified file or not.\nmembers.canEditAccess - Specifies if the user can edit the access to the specified file or not.\nmembers.subjectType - The subject type.\nwarning - The warning message.\nerror - The error type.', 'enum': ['members.access', 'members.sharedTo', 'members.isLocked', 'members.isOwner', 'members.canEditAccess', 'members.subjectType', 'warning', 'error']}}, 'filterType': {'type': 'number', 'description': 'The filter type of the access rights.\n\n0 - User or group\n1 - Invitation link\n2 - External link\n4 - Additional external link\n8 - Primary external link\n16 - User\n32 - Group', 'enum': [0, 1, 2, 4, 8, 16, 32]}, 'filterValue': {'type': 'string', 'description': 'The text filter value used for filtering room security information.'}, 'startIndex': {'type': 'number', 'description': 'The starting index of the items to retrieve in a paginated request.'}}, 'additionalProperties': False}, 'roomId': {'type': 'number', 'description': 'The ID of the room to get a list of users with their access level for.'}}, 'required': ['roomId', 'filters'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'get_room_types', 'description': 'Get a list of available room types.', 'parameters': {'type': 'object', 'properties': {}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'get_rooms_folder', 'description': "Get the 'Rooms' folder.", 'parameters': {'type': 'object', 'properties': {'filters': {'type': 'object', 'description': 'The filters to apply to the rooms folder.', 'required': ['fields'], 'properties': {'count': {'type': 'number', 'description': 'Specifies the maximum number of items to retrieve.', 'default': 30, 'minimum': 1, 'maximum': 50}, 'excludeSubject': {'type': 'boolean', 'description': 'Specifies whether to exclude search by user or group ID.'}, 'fields': {'type': 'array', 'items': {'type': 'string', 'description': 'The fields to include in the response.\n\nfiles.id - The file entry ID.\nfiles.rootFolderId - The root folder ID of the file entry.\nfiles.canShare - Specifies if the file entry can be shared or not.\nfiles.security - The actions that can be performed with the file entry.\nfiles.title - The file entry title.\nfiles.access - The access rights to the file entry.\nfiles.shared - Specifies if the file entry is shared or not.\nfiles.created.utcTime - The time in UTC format.\nfiles.createdBy.id - The user ID.\nfiles.createdBy.displayName - The user display name.\nfiles.createdBy.isAnonim - Specifies if the user is anonymous or not.\nfiles.fileEntryType - The file entry type.\nfiles.folderId - The folder ID where the file is located.\nfiles.fileType - The file type.\nfiles.fileExst - The file extension.\nfiles.comment - The comment to the file.\nfiles.encrypted - Specifies if the file is encrypted or not.\nfiles.locked - Specifies if the file is locked or not.\nfolders.id - The file entry ID.\nfolders.rootFolderId - The root folder ID of the file entry.\nfolders.canShare - Specifies if the file entry can be shared or not.\nfolders.security - The actions that can be performed with the file entry.\nfolders.title - The file entry title.\nfolders.access - The access rights to the file entry.\nfolders.shared - Specifies if the file entry is shared or not.\nfolders.created.utcTime - The time in UTC format.\nfolders.createdBy.id - The user ID.\nfolders.createdBy.displayName - The user display name.\nfolders.createdBy.isAnonim - Specifies if the user is anonymous or not.\nfolders.fileEntryType - The file entry type.\nfolders.parentId - The parent folder ID of the folder.\nfolders.filesCount - The number of files that the folder contains.\nfolders.foldersCount - The number of folders that the folder contains.\nfolders.isShareable - Specifies if the folder can be shared or not.\nfolders.isFavorite - Specifies if the folder is favorite or not.\nfolders.tags - The list of tags of the folder.\nfolders.roomType - The room type of the folder.\nfolders.private - Specifies if the folder is private or not.\nfolders.type - The folder type.\nfolders.inRoom - Specifies if the folder is placed in the room or not.\ncurrent.id - The file entry ID.\ncurrent.rootFolderId - The root folder ID of the file entry.\ncurrent.canShare - Specifies if the file entry can be shared or not.\ncurrent.security - The actions that can be performed with the file entry.\ncurrent.title - The file entry title.\ncurrent.access - The access rights to the file entry.\ncurrent.shared - Specifies if the file entry is shared or not.\ncurrent.created.utcTime - The time in UTC format.\ncurrent.createdBy.id - The user ID.\ncurrent.createdBy.displayName - The user display name.\ncurrent.createdBy.isAnonim - Specifies if the user is anonymous or not.\ncurrent.fileEntryType - The file entry type.\ncurrent.parentId - The parent folder ID of the folder.\ncurrent.filesCount - The number of files that the folder contains.\ncurrent.foldersCount - The number of folders that the folder contains.\ncurrent.isShareable - Specifies if the folder can be shared or not.\ncurrent.isFavorite - Specifies if the folder is favorite or not.\ncurrent.tags - The list of tags of the folder.\ncurrent.roomType - The room type of the folder.\ncurrent.private - Specifies if the folder is private or not.\ncurrent.type - The folder type.\ncurrent.inRoom - Specifies if the folder is placed in the room or not.\nstartIndex - The folder start index.\ncount - The number of folder elements.\ntotal - The total number of elements in the folder.', 'enum': ['files.id', 'files.rootFolderId', 'files.canShare', 'files.security', 'files.title', 'files.access', 'files.shared', 'files.created.utcTime', 'files.createdBy.id', 'files.createdBy.displayName', 'files.createdBy.isAnonim', 'files.fileEntryType', 'files.folderId', 'files.fileType', 'files.fileExst', 'files.comment', 'files.encrypted', 'files.locked', 'folders.id', 'folders.rootFolderId', 'folders.canShare', 'folders.security', 'folders.title', 'folders.access', 'folders.shared', 'folders.created.utcTime', 'folders.createdBy.id', 'folders.createdBy.displayName', 'folders.createdBy.isAnonim', 'folders.fileEntryType', 'folders.parentId', 'folders.filesCount', 'folders.foldersCount', 'folders.isShareable', 'folders.isFavorite', 'folders.tags', 'folders.roomType', 'folders.private', 'folders.type', 'folders.inRoom', 'current.id', 'current.rootFolderId', 'current.canShare', 'current.security', 'current.title', 'current.access', 'current.shared', 'current.created.utcTime', 'current.createdBy.id', 'current.createdBy.displayName', 'current.createdBy.isAnonim', 'current.fileEntryType', 'current.parentId', 'current.filesCount', 'current.foldersCount', 'current.isShareable', 'current.isFavorite', 'current.tags', 'current.roomType', 'current.private', 'current.type', 'current.inRoom', 'startIndex', 'count', 'total']}}, 'filterValue': {'type': 'string', 'description': 'The text used for filtering or searching folder contents.'}, 'searchArea': {'type': 'string', 'description': 'The room search area (Active, Archive, Any, Recent by links).', 'enum': ['Active', 'Archive', 'Any', 'RecentByLinks', 'Template']}, 'sortBy': {'type': 'string', 'description': 'Specifies the field by which the room content should be sorted.'}, 'sortOrder': {'type': 'number', 'description': 'The order in which the results are sorted.\n\n0 - Ascending order\n1 - Descending order', 'enum': [0, 1]}, 'startIndex': {'type': 'number', 'description': 'The index from which to start retrieving the room content.'}, 'subjectId': {'type': 'string', 'description': 'The filter by user ID.'}, 'tags': {'type': 'string', 'description': 'The tags in the serialized format.'}, 'type': {'type': 'array', 'items': {'type': 'number', 'description': 'The filter by room type.\n\n1 - Form Filling Room. Upload PDF forms into the room. Invite members and guests to fill out a PDF form. Review completed forms and analyze data automatically collected in a spreadsheet.\n2 - Collaboration room. Collaborate on one or multiple documents with your team.\n5 - Custom room. Apply your own settings to use this room for any custom purpose.\n6 - Public room. Share documents for viewing, editing, commenting, or reviewing without registration. You can also embed this room into any web interface.\n8 - Virtual Data Room. Use VDR for advanced file security and transparency. Set watermarks, automatically index and track all content, restrict downloading and copying.', 'enum': [1, 2, 5, 6, 8]}}, 'withoutTags': {'type': 'boolean', 'description': 'Specifies whether to search by tags or not.'}}, 'additionalProperties': False}}, 'required': ['filters'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'move_batch_items', 'description': 'Move to a folder.', 'parameters': {'type': 'object', 'properties': {'destFolderId': {'description': 'The ID of the destination folder to move the items to.'}, 'fileIds': {'type': 'array', 'description': 'The IDs of the files to move.', 'items': True}, 'folderIds': {'type': 'array', 'description': 'The IDs of the folders to move items to.', 'items': True}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'rename_folder', 'description': 'Rename a folder.', 'parameters': {'type': 'object', 'properties': {'filters': {'type': 'object', 'description': 'The filters to apply to the folder renaming. Use them to reduce the size of the response.', 'required': ['fields'], 'properties': {'fields': {'type': 'array', 'items': {'type': 'string', 'description': 'The fields to include in the response.\n\nid - The file entry ID.\nrootFolderId - The root folder ID of the file entry.\ncanShare - Specifies if the file entry can be shared or not.\nsecurity - The actions that can be performed with the file entry.\ntitle - The file entry title.\naccess - The access rights to the file entry.\nshared - Specifies if the file entry is shared or not.\ncreated.utcTime - The time in UTC format.\ncreatedBy.id - The user ID.\ncreatedBy.displayName - The user display name.\ncreatedBy.isAnonim - Specifies if the user is anonymous or not.\nfileEntryType - The file entry type.\nparentId - The parent folder ID of the folder.\nfilesCount - The number of files that the folder contains.\nfoldersCount - The number of folders that the folder contains.\nisShareable - Specifies if the folder can be shared or not.\nisFavorite - Specifies if the folder is favorite or not.\ntags - The list of tags of the folder.\nroomType - The room type of the folder.\nprivate - Specifies if the folder is private or not.\ntype - The folder type.\ninRoom - Specifies if the folder is placed in the room or not.', 'enum': ['id', 'rootFolderId', 'canShare', 'security', 'title', 'access', 'shared', 'created.utcTime', 'createdBy.id', 'createdBy.displayName', 'createdBy.isAnonim', 'fileEntryType', 'parentId', 'filesCount', 'foldersCount', 'isShareable', 'isFavorite', 'tags', 'roomType', 'private', 'type', 'inRoom']}}}, 'additionalProperties': False}, 'folderId': {'type': 'number', 'description': 'The ID of the folder to rename.'}, 'title': {'type': 'string', 'description': 'The new title of the folder to set.'}}, 'required': ['folderId', 'title', 'filters'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'set_room_security', 'description': 'Invite or remove users from a room.', 'parameters': {'type': 'object', 'properties': {'culture': {'type': 'string', 'description': 'The languages to use for the invitation.'}, 'filters': {'type': 'object', 'description': 'The filters to apply to the room security info.', 'required': ['fields'], 'properties': {'fields': {'type': 'array', 'items': {'type': 'string', 'description': 'The fields to include in the response.\n\nmembers.access - The access rights type.\nmembers.sharedTo - The user who has the access to the specified file.\nmembers.isLocked - Specifies if the access right is locked or not.\nmembers.isOwner - Specifies if the user is an owner of the specified file or not.\nmembers.canEditAccess - Specifies if the user can edit the access to the specified file or not.\nmembers.subjectType - The subject type.\nwarning - The warning message.\nerror - The error type.', 'enum': ['members.access', 'members.sharedTo', 'members.isLocked', 'members.isOwner', 'members.canEditAccess', 'members.subjectType', 'warning', 'error']}}}, 'additionalProperties': False}, 'invitations': {'type': 'array', 'description': 'The invitations or removals to perform.', 'items': {'type': 'object', 'description': 'The invitation or removal of a user. Must contain either User ID or User Email.', 'properties': {'access': {'type': 'number', 'description': "The access level to grant to the user. May vary depending on the type of room.\n\n0 - None. No access to the room.\n2 - Viewer. File viewing.\n5 - Reviewer. Operations with existing files: viewing, reviewing, commenting.\n6 - Commenter. Operations with existing files: viewing, commenting.\n7 - Form filler. Form fillers can fill out forms and view only their completed/started forms within the Complete and In Process folders.\n9 - Room manager (Paid). Room managers can manage the assigned rooms, invite new users and assign roles below their level.\n10 - Editor. Operations with existing files: viewing, editing, form filling, reviewing, commenting.\n11 - Content creator. Content creators can create and edit files in the room, but can't manage users, or access settings.", 'enum': [0, 2, 5, 6, 7, 9, 10, 11]}, 'email': {'type': 'string', 'description': 'The email of the user to invite or remove. Mutually exclusive with User ID.'}, 'id': {'type': 'string', 'description': 'The ID of the user to invite or remove. Mutually exclusive with User Email.'}}, 'additionalProperties': False}}, 'message': {'type': 'string', 'description': 'The message to use for the invitation.'}, 'notify': {'type': 'boolean', 'description': 'Whether to notify the user.'}, 'roomId': {'type': 'number', 'description': 'The ID of the room to invite or remove users from.'}}, 'required': ['roomId', 'invitations', 'filters'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'update_file', 'description': 'Update a file.', 'parameters': {'type': 'object', 'properties': {'fileId': {'type': 'number', 'description': 'The ID of the file to update.'}, 'title': {'type': 'string', 'description': 'The new title of the file to set.'}}, 'required': ['fileId', 'title'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'update_room', 'description': 'Update a room.', 'parameters': {'type': 'object', 'properties': {'filters': {'type': 'object', 'description': 'The filters to apply to the room update.', 'required': ['fields'], 'properties': {'fields': {'type': 'array', 'items': {'type': 'string', 'description': 'The fields to include in the response.\n\nid - The file entry ID.\nrootFolderId - The root folder ID of the file entry.\ncanShare - Specifies if the file entry can be shared or not.\nsecurity - The actions that can be performed with the file entry.\ntitle - The file entry title.\naccess - The access rights to the file entry.\nshared - Specifies if the file entry is shared or not.\ncreated.utcTime - The time in UTC format.\ncreatedBy.id - The user ID.\ncreatedBy.displayName - The user display name.\ncreatedBy.isAnonim - Specifies if the user is anonymous or not.\nfileEntryType - The file entry type.\nparentId - The parent folder ID of the folder.\nfilesCount - The number of files that the folder contains.\nfoldersCount - The number of folders that the folder contains.\nisShareable - Specifies if the folder can be shared or not.\nisFavorite - Specifies if the folder is favorite or not.\ntags - The list of tags of the folder.\nroomType - The room type of the folder.\nprivate - Specifies if the folder is private or not.\ntype - The folder type.\ninRoom - Specifies if the folder is placed in the room or not.', 'enum': ['id', 'rootFolderId', 'canShare', 'security', 'title', 'access', 'shared', 'created.utcTime', 'createdBy.id', 'createdBy.displayName', 'createdBy.isAnonim', 'fileEntryType', 'parentId', 'filesCount', 'foldersCount', 'isShareable', 'isFavorite', 'tags', 'roomType', 'private', 'type', 'inRoom']}}}, 'additionalProperties': False}, 'roomId': {'type': 'number', 'description': 'The ID of the room to update.'}, 'title': {'type': 'string', 'description': 'The new title of the room to set.'}}, 'required': ['roomId', 'filters'], 'additionalProperties': False}, 'strict': True}
|
onlyoffice-docspace
|
other
|
{'type': 'function', 'name': 'upload_file', 'description': 'Upload a file.', 'parameters': {'type': 'object', 'properties': {'content': {'type': 'string', 'description': 'The content of the file to upload.'}, 'filename': {'type': 'string', 'description': 'The file name with an extension to upload.'}, 'parentId': {'type': 'number', 'description': 'The ID of the room or folder to upload the file to.'}}, 'required': ['parentId', 'filename', 'content'], 'additionalProperties': False}, 'strict': True}
|
openapi
|
other
|
{'type': 'function', 'name': 'create_csharp_snippet', 'description': 'Generate a C# code snippet for a given operation ID from a URL OR a raw JSON string or file contents pointing to an OpenAPI or Swagger JSON document.', 'parameters': {'type': 'object', 'properties': {'addressOrFileContents': {'type': 'string', 'description': 'URL address of the OpenAPI or Swagger JSON document OR raw JSON contents of the OpenAPI or Swagger specification. Can be provided as text or from a file.'}, 'baseAddress': {'type': 'string', 'description': 'Optional base URL to be used in the generated cURL command.'}, 'operationId': {'type': 'string', 'description': 'Operation ID for which to create a snippet.'}}, 'required': ['addressOrFileContents', 'operationId', 'baseAddress'], 'additionalProperties': False}, 'strict': True}
|
openapi
|
other
|
{'type': 'function', 'name': 'generate_curl_command', 'description': 'Generate a cURL command for a given operation ID from a URL OR a raw JSON string or file contents pointing to an OpenAPI or Swagger JSON document.', 'parameters': {'type': 'object', 'properties': {'addressOrFileContents': {'type': 'string', 'description': 'URL address of the OpenAPI or Swagger JSON document OR raw JSON contents of the OpenAPI or Swagger specification. Can be provided as text or from a file.'}, 'baseAddress': {'type': 'string', 'description': 'Optional base URL to be used in the generated cURL command.'}, 'operationId': {'type': 'string', 'description': 'Operation ID for which to generate the cURL command.'}}, 'required': ['addressOrFileContents', 'operationId', 'baseAddress'], 'additionalProperties': False}, 'strict': True}
|
openapi
|
other
|
{'type': 'function', 'name': 'get_known_responses', 'description': 'Analyze an OpenAPI or Swagger document provided as a URL OR a raw JSON string or file contents, and list possible HTTP responses (status codes and descriptions) for the specified operation ID.', 'parameters': {'type': 'object', 'properties': {'addressOrFileContents': {'type': 'string', 'description': 'URL address of the OpenAPI or Swagger JSON document OR raw JSON contents of the OpenAPI or Swagger specification. Can be provided as text or from a file.'}, 'operationId': {'type': 'string', 'description': 'Operation ID for which to retrieve known responses.'}}, 'required': ['addressOrFileContents', 'operationId'], 'additionalProperties': False}, 'strict': True}
|
openapi
|
other
|
{'type': 'function', 'name': 'get_list_of_operations', 'description': 'Retrieve a list of operations (endpoints) from a URL OR a raw JSON string or file contents pointing to an OpenAPI or Swagger JSON document.', 'parameters': {'type': 'object', 'properties': {'addressOrFileContents': {'type': 'string', 'description': 'URL address of the OpenAPI or Swagger JSON document OR raw JSON contents of the OpenAPI or Swagger specification. Can be provided as text or from a file.'}}, 'required': ['addressOrFileContents'], 'additionalProperties': False}, 'strict': True}
|
openapi
|
other
|
{'type': 'function', 'name': 'validate_document', 'description': 'Analyze and validate an OpenAPI or Swagger document provided as a URL OR a raw JSON string or file contents, and list possible errors, issues and problems with specification for the specified operation ID.', 'parameters': {'type': 'object', 'properties': {'addressOrFileContents': {'type': 'string', 'description': 'URL address of the OpenAPI or Swagger JSON document OR raw JSON contents of the OpenAPI or Swagger specification. Can be provided as text or from a file.'}}, 'required': ['addressOrFileContents'], 'additionalProperties': False}, 'strict': True}
|
openbnb-airbnb
|
other
|
{'type': 'function', 'name': 'airbnb_listing_details', 'description': 'Get detailed information about a specific Airbnb listing. Provide direct links to the user', 'parameters': {'type': 'object', 'properties': {'adults': {'type': 'number', 'description': 'Number of adults'}, 'checkin': {'type': 'string', 'description': 'Check-in date (YYYY-MM-DD)'}, 'checkout': {'type': 'string', 'description': 'Check-out date (YYYY-MM-DD)'}, 'children': {'type': 'number', 'description': 'Number of children'}, 'id': {'type': 'string', 'description': 'The Airbnb listing ID'}, 'ignoreRobotsText': {'type': 'boolean', 'description': 'Ignore robots.txt rules for this request'}, 'infants': {'type': 'number', 'description': 'Number of infants'}, 'pets': {'type': 'number', 'description': 'Number of pets'}}, 'required': ['id'], 'additionalProperties': False}, 'strict': True}
|
openbnb-airbnb
|
other
|
{'type': 'function', 'name': 'airbnb_search', 'description': 'Search for Airbnb listings with various filters and pagination. Provide direct links to the user', 'parameters': {'type': 'object', 'properties': {'adults': {'type': 'number', 'description': 'Number of adults'}, 'checkin': {'type': 'string', 'description': 'Check-in date (YYYY-MM-DD)'}, 'checkout': {'type': 'string', 'description': 'Check-out date (YYYY-MM-DD)'}, 'children': {'type': 'number', 'description': 'Number of children'}, 'cursor': {'type': 'string', 'description': 'Base64-encoded string used for Pagination'}, 'ignoreRobotsText': {'type': 'boolean', 'description': 'Ignore robots.txt rules for this request'}, 'infants': {'type': 'number', 'description': 'Number of infants'}, 'location': {'type': 'string', 'description': 'Location to search for (city, state, etc.)'}, 'maxPrice': {'type': 'number', 'description': 'Maximum price for the stay'}, 'minPrice': {'type': 'number', 'description': 'Minimum price for the stay'}, 'pets': {'type': 'number', 'description': 'Number of pets'}, 'placeId': {'type': 'string', 'description': 'Google Maps Place ID (overrides the location parameter)'}}, 'required': ['location'], 'additionalProperties': False}, 'strict': True}
|
openmesh
|
other
|
{'type': 'function', 'name': 'call_service', 'description': 'Call a tool on a discovered MCP server through OpenMesh proxy', 'parameters': {'type': 'object', 'properties': {'args': {'type': 'object', 'description': 'Arguments to pass to the tool', 'additionalProperties': True}, 'serverName': {'type': 'string', 'description': 'Name of the MCP server to call (from discover_service results)'}, 'tool': {'type': 'string', 'description': 'Name of the tool to call on the server'}}, 'required': ['serverName', 'tool'], 'additionalProperties': False}, 'strict': True}
|
openmesh
|
other
|
{'type': 'function', 'name': 'discover_service', 'description': 'Discover MCP servers by capability, or list all available servers', 'parameters': {'type': 'object', 'properties': {'capability': {'type': 'string', 'description': 'The capability to search for (e.g., "docs", "weather", "search"). If omitted, lists all available servers.'}, 'limit': {'type': 'number', 'description': 'Maximum number of results to return (default: 5 for search, 20 for list all)', 'default': 5}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
openmesh
|
other
|
{'type': 'function', 'name': 'get_alternative', 'description': 'Get alternative MCP servers when one fails or is unavailable', 'parameters': {'type': 'object', 'properties': {'failed_server': {'type': 'string', 'description': 'Name of the MCP server that failed or is unavailable'}}, 'required': ['failed_server'], 'additionalProperties': False}, 'strict': True}
|
openmesh
|
other
|
{'type': 'function', 'name': 'report_experience', 'description': 'Report your experience with an MCP server to help improve recommendations', 'parameters': {'type': 'object', 'properties': {'errorType': {'type': 'string', 'description': 'Type of error encountered (if any)', 'enum': ['timeout', 'auth_failed', 'tool_not_found', 'invalid_response', 'other']}, 'notes': {'type': 'string', 'description': 'Additional notes about the experience'}, 'server': {'type': 'string', 'description': 'Name of the MCP server'}, 'success': {'type': 'boolean', 'description': 'Whether the interaction was successful'}}, 'required': ['server', 'success'], 'additionalProperties': False}, 'strict': True}
|
openweather
|
other
|
{'type': 'function', 'name': 'weather', 'description': 'Retrieves current and forecast weather information for a given location.', 'parameters': {'type': 'object', 'properties': {'city': {'type': 'string', 'description': 'The name of the city to get weather for.\nMust be in English.\nExample: For Saint Petersburg, use "Saint Petersburg", not "Санкт-Петербург".'}, 'lang': {'type': 'string', 'description': 'The language for the weather description text. Use standard two-letter language codes (e.g., "en", "es", "zh_CN"). Default: "en".', 'default': 'en'}, 'units': {'type': 'string', 'description': 'The unit for temperature. Use "c" for Celsius, "f" for Fahrenheit, or "k" for Kelvin. Default: "c".', 'default': 'c'}}, 'required': ['city'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-cairo
|
other
|
{'type': 'function', 'name': 'cairo-account', 'description': 'Make a custom smart contract that represents an account that can be deployed and interacted with other contracts, and can be extended to implement custom logic. An account is a special type of contract that is used to validate and execute transactions.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'declare': {'type': 'boolean', 'description': 'Whether to enable the account to declare other contract classes.'}, 'deploy': {'type': 'boolean', 'description': 'Whether to enables the account to be counterfactually deployed.'}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'outsideExecution': {'type': 'boolean', 'description': 'Whether to allow a protocol to submit transactions on behalf of the account, as long as it has the relevant signatures.'}, 'pubkey': {'type': 'boolean', 'description': 'Whether to enables the account to change its own public key.'}, 'type': {'type': 'string', 'description': 'Type of signature used for signature checking by the Account contract, Starknet account uses the STARK curve, Ethereum-flavored account uses the Secp256k1 curve.', 'enum': ['stark', 'eth']}, 'upgradeable': {'type': 'boolean', 'description': 'Whether the smart contract is upgradeable.'}}, 'required': ['name', 'type'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-cairo
|
other
|
{'type': 'function', 'name': 'cairo-custom', 'description': 'Make a custom smart contract.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'access': {'type': 'string', 'description': 'The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts.', 'enum': ['ownable', 'roles']}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'pausable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to pause specifically marked functionality. Useful for emergency response.'}, 'upgradeable': {'type': 'boolean', 'description': 'Whether the smart contract is upgradeable.'}}, 'required': ['name'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-cairo
|
other
|
{'type': 'function', 'name': 'cairo-erc1155', 'description': 'Make a non-fungible token per the ERC-1155 standard.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'access': {'type': 'string', 'description': 'The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts.', 'enum': ['ownable', 'roles']}, 'baseUri': {'type': 'string', 'description': 'The location of the metadata for the token. Clients will replace any instance of {id} in this string with the tokenId.'}, 'burnable': {'type': 'boolean', 'description': 'Whether token holders will be able to destroy their tokens'}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'mintable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to create more supply or emit more tokens'}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'pausable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to pause specifically marked functionality. Useful for emergency response.'}, 'royaltyInfo': {'type': 'object', 'description': 'Provides information for how much royalty is owed and to whom, based on a sale price. Follows ERC-2981 standard.', 'required': ['enabled', 'defaultRoyaltyFraction', 'feeDenominator'], 'properties': {'defaultRoyaltyFraction': {'type': 'string', 'description': "The royalty fraction that will be default for all tokens. It will be used for a token if there's no custom royalty fraction set for it."}, 'enabled': {'type': 'boolean', 'description': 'Whether to enable royalty feature for the contract'}, 'feeDenominator': {'type': 'string', 'description': "The denominator used to interpret a token's fee and to calculate the result fee fraction."}}, 'additionalProperties': False}, 'updatableUri': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to set a new URI for all token types.'}, 'upgradeable': {'type': 'boolean', 'description': 'Whether the smart contract is upgradeable.'}}, 'required': ['name', 'baseUri'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-cairo
|
other
|
{'type': 'function', 'name': 'cairo-erc20', 'description': 'Make a fungible token per the ERC-20 standard.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'access': {'type': 'string', 'description': 'The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts.', 'enum': ['ownable', 'roles']}, 'appName': {'type': 'string', 'description': 'Required when votes is enabled, for hashing and signing typed structured data. Name for domain separator implementing SNIP12Metadata trait. Prevents two applications from producing the same hash.'}, 'appVersion': {'type': 'string', 'description': 'Required when votes is enabled, for hashing and signing typed structured data. Version for domain separator implementing SNIP12Metadata trait. Prevents two versions of the same application from producing the same hash.'}, 'burnable': {'type': 'boolean', 'description': 'Whether token holders will be able to destroy their tokens'}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'mintable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to create more supply or emit more tokens'}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'pausable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to pause specifically marked functionality. Useful for emergency response.'}, 'premint': {'type': 'string', 'description': 'The number of tokens to premint for the deployer.'}, 'symbol': {'type': 'string', 'description': 'The short symbol for the token'}, 'upgradeable': {'type': 'boolean', 'description': 'Whether the smart contract is upgradeable.'}, 'votes': {'type': 'boolean', 'description': "Whether to keep track of historical balances for voting in on-chain governance, with a way to delegate one's voting power to a trusted account."}}, 'required': ['name', 'symbol'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-cairo
|
other
|
{'type': 'function', 'name': 'cairo-erc721', 'description': 'Make a non-fungible token per the ERC-721 standard.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'access': {'type': 'string', 'description': 'The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts.', 'enum': ['ownable', 'roles']}, 'appName': {'type': 'string', 'description': 'Required when votes is enabled, for hashing and signing typed structured data. Name for domain separator implementing SNIP12Metadata trait. Prevents two applications from producing the same hash.'}, 'appVersion': {'type': 'string', 'description': 'Required when votes is enabled, for hashing and signing typed structured data. Version for domain separator implementing SNIP12Metadata trait. Prevents two versions of the same application from producing the same hash.'}, 'baseUri': {'type': 'string', 'description': 'A base uri for the non-fungible token.'}, 'burnable': {'type': 'boolean', 'description': 'Whether token holders will be able to destroy their tokens'}, 'enumerable': {'type': 'boolean', 'description': 'Whether to allow on-chain enumeration of all tokens or those owned by an account. Increases gas cost of transfers.'}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'mintable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to create more supply or emit more tokens'}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'pausable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to pause specifically marked functionality. Useful for emergency response.'}, 'royaltyInfo': {'type': 'object', 'description': 'Provides information for how much royalty is owed and to whom, based on a sale price. Follows ERC-2981 standard.', 'required': ['enabled', 'defaultRoyaltyFraction', 'feeDenominator'], 'properties': {'defaultRoyaltyFraction': {'type': 'string', 'description': "The royalty fraction that will be default for all tokens. It will be used for a token if there's no custom royalty fraction set for it."}, 'enabled': {'type': 'boolean', 'description': 'Whether to enable royalty feature for the contract'}, 'feeDenominator': {'type': 'string', 'description': "The denominator used to interpret a token's fee and to calculate the result fee fraction."}}, 'additionalProperties': False}, 'symbol': {'type': 'string', 'description': 'The short symbol for the token'}, 'upgradeable': {'type': 'boolean', 'description': 'Whether the smart contract is upgradeable.'}, 'votes': {'type': 'boolean', 'description': 'Whether to keep track of individual units for voting in on-chain governance. Voting durations can be expressed as block numbers or timestamps.'}}, 'required': ['name', 'symbol'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-cairo
|
other
|
{'type': 'function', 'name': 'cairo-governor', 'description': 'Make a contract to implement governance, such as for a DAO.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'appName': {'type': 'string', 'description': 'Required when votes is enabled, for hashing and signing typed structured data. Name for domain separator implementing SNIP12Metadata trait. Prevents two applications from producing the same hash.'}, 'appVersion': {'type': 'string', 'description': 'Required when votes is enabled, for hashing and signing typed structured data. Version for domain separator implementing SNIP12Metadata trait. Prevents two versions of the same application from producing the same hash.'}, 'clockMode': {'type': 'string', 'description': 'The clock mode used by the voting token. For now, only timestamp mode where the token uses voting durations expressed as timestamps is supported. For Governor, this must be chosen to match what the ERC20 or ERC721 voting token uses.', 'enum': ['timestamp']}, 'decimals': {'type': 'number', 'description': 'The number of decimals to use for the contract, default is 18 for ERC20Votes and 0 for ERC721Votes (because it does not apply to ERC721Votes).'}, 'delay': {'type': 'string', 'description': 'The delay since proposal is created until voting starts, in readable date time format matching /^(\\d+(?:\\.\\d+)?) +(second|minute|hour|day|week|month|year)s?$/, default is "1 day".'}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'period': {'type': 'string', 'description': 'The length of period during which people can cast their vote, in readable date time format matching /^(\\d+(?:\\.\\d+)?) +(second|minute|hour|day|week|month|year)s?$/, default is "1 week".'}, 'proposalThreshold': {'type': 'string', 'description': 'Minimum number of votes an account must have to create a proposal, default is 0.'}, 'quorumAbsolute': {'type': 'string', 'description': 'The absolute quorum required, in cases of quorumMode equals absolute.'}, 'quorumMode': {'type': 'string', 'description': 'The type of quorum mode to use, either by percentage or absolute value.', 'enum': ['percent', 'absolute']}, 'quorumPercent': {'type': 'number', 'description': 'The percent required, in cases of quorumMode equals percent.'}, 'settings': {'type': 'boolean', 'description': 'Whether to allow governance to update voting settings (delay, period, proposal threshold).'}, 'timelock': {'type': ['boolean', 'string'], 'description': 'Whether to add a delay to actions taken by the Governor. Gives users time to exit the system if they disagree with governance decisions. If "openzeppelin", Module compatible with OpenZeppelin\'s TimelockController.', 'enum': [False, 'openzeppelin']}, 'upgradeable': {'type': 'boolean', 'description': 'Whether the smart contract is upgradeable.'}, 'votes': {'type': 'string', 'description': 'The type of voting to use. Either erc20votes, meaning voting power with a votes-enabled ERC20 token. Either erc721votes, meaning voting power with a votes-enabled ERC721 token. Voters can entrust their voting power to a delegate.', 'enum': ['erc20votes', 'erc721votes']}}, 'required': ['name', 'delay', 'period'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-cairo
|
other
|
{'type': 'function', 'name': 'cairo-multisig', 'description': 'Make a multi-signature smart contract, requiring a quorum of registered signers to approve and collectively execute transactions.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'quorum': {'type': 'string', 'description': 'The minimal number of confirmations required by the Multisig to approve a transaction.'}, 'upgradeable': {'type': 'boolean', 'description': 'Whether the smart contract is upgradeable.'}}, 'required': ['name', 'quorum'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-cairo
|
other
|
{'type': 'function', 'name': 'cairo-vesting', 'description': 'Make a vesting smart contract that manages the gradual release of ERC-20 tokens to a designated beneficiary based on a predefined vesting schedule.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'cliffDuration': {'type': 'string', 'description': 'The duration of the cliff period. Must be less than or equal to the total duration. In readable date time format matching /^(\\d+(?:\\.\\d+)?) +(second|minute|hour|day|week|month|year)s?$/'}, 'duration': {'type': 'string', 'description': 'The total duration of the vesting period. In readable date time format matching /^(\\d+(?:\\.\\d+)?) +(second|minute|hour|day|week|month|year)s?$/'}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'schedule': {'type': 'string', 'description': 'A vesting schedule implementation, tokens can either be vested gradually following a linear curve or with custom vesting schedule that requires the implementation of the VestingSchedule trait.', 'enum': ['linear', 'custom']}, 'startDate': {'type': 'string', 'description': 'The timestamp marking the beginning of the vesting period. In HTML input datetime-local format'}}, 'required': ['name', 'startDate', 'duration', 'cliffDuration', 'schedule'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-solidity
|
other
|
{'type': 'function', 'name': 'solidity-account', 'description': 'Make an account contract that follows the ERC-4337 standard. Experimental, some features are not audited and are subject to change.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'ERC1155Holder': {'type': 'boolean', 'description': 'Whether to implement the `onERC1155Received` function to allow the account to receive ERC1155 tokens.'}, 'ERC721Holder': {'type': 'boolean', 'description': 'Whether to implement the `onERC721Received` function to allow the account to receive ERC721 tokens.'}, 'ERC7579Modules': {'description': 'Whether to implement the ERC-7579 compatibility to enable functionality on the account with modules.', 'anyOf': [{'type': ['boolean', 'string'], 'enum': [False, 'AccountERC7579']}, {'type': 'string', 'const': 'AccountERC7579Hooked'}]}, 'batchedExecution': {'type': 'boolean', 'description': 'Whether to implement a minimal batching interface for the account to allow multiple operations to be executed in a single transaction following the ERC-7821 standard.'}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'name': {'type': 'string', 'description': 'The name of the account contract'}, 'signatureValidation': {'description': 'Whether to implement the ERC-1271 standard for validating signatures. This is useful for the account to verify signatures.', 'anyOf': [{'type': ['boolean', 'string'], 'enum': [False, 'ERC1271']}, {'type': 'string', 'const': 'ERC7739'}]}, 'signer': {'description': "Defines the signature verification algorithm used by the account to verify user operations. Options:\n - ECDSA: Standard Ethereum signature validation using secp256k1, validates signatures against a specified owner address\n - ERC7702: Special ECDSA validation using account's own address as signer, enables EOAs to delegate execution rights\n - P256: NIST P-256 curve (secp256r1) validation for integration with Passkeys and HSMs\n - RSA: RSA PKCS#1 v1.5 signature validation (RFC8017) for PKI systems and HSMs\n - Multisig: ERC-7913 multisignature requiring minimum number of signatures from authorized signers\n - MultisigWeighted: ERC-7913 weighted multisignature where signers have different voting weights", 'anyOf': [{'anyOf': [{'anyOf': [{'anyOf': [{'anyOf': [{'type': ['boolean', 'string'], 'enum': [False, 'ERC7702']}, {'type': 'string', 'const': 'ECDSA'}]}, {'type': 'string', 'const': 'P256'}]}, {'type': 'string', 'const': 'RSA'}]}, {'type': 'string', 'const': 'Multisig'}]}, {'type': 'string', 'const': 'MultisigWeighted'}]}}, 'required': ['name'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-solidity
|
other
|
{'type': 'function', 'name': 'solidity-custom', 'description': 'Make a custom smart contract.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'access': {'description': 'The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts. Managed enables a central contract to define a policy that allows certain callers to access certain functions.', 'anyOf': [{'type': 'string', 'enum': ['ownable', 'roles']}, {'type': 'string', 'const': 'managed'}]}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'pausable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to pause specifically marked functionality. Useful for emergency response.'}, 'upgradeable': {'type': 'string', 'description': 'Whether the smart contract is upgradeable. Transparent uses more complex proxy with higher overhead, requires less changes in your contract. Can also be used with beacons. UUPS uses simpler proxy with less overhead, requires including extra code in your contract. Allows flexibility for authorizing upgrades.', 'enum': ['transparent', 'uups']}}, 'required': ['name'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-solidity
|
other
|
{'type': 'function', 'name': 'solidity-erc1155', 'description': 'Make a non-fungible token per the ERC-1155 standard.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'access': {'description': 'The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts. Managed enables a central contract to define a policy that allows certain callers to access certain functions.', 'anyOf': [{'type': 'string', 'enum': ['ownable', 'roles']}, {'type': 'string', 'const': 'managed'}]}, 'burnable': {'type': 'boolean', 'description': 'Whether token holders will be able to destroy their tokens'}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'mintable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to create more supply or emit more tokens'}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'pausable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to pause specifically marked functionality. Useful for emergency response.'}, 'supply': {'type': 'boolean', 'description': 'Whether to keep track of total supply of tokens'}, 'updatableUri': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to set a new URI for all token types'}, 'upgradeable': {'type': 'string', 'description': 'Whether the smart contract is upgradeable. Transparent uses more complex proxy with higher overhead, requires less changes in your contract. Can also be used with beacons. UUPS uses simpler proxy with less overhead, requires including extra code in your contract. Allows flexibility for authorizing upgrades.', 'enum': ['transparent', 'uups']}, 'uri': {'type': 'string', 'description': 'The location of the metadata for the token. Clients will replace any instance of {id} in this string with the tokenId.'}}, 'required': ['name', 'uri'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-solidity
|
other
|
{'type': 'function', 'name': 'solidity-erc20', 'description': 'Make a fungible token per the ERC-20 standard.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'access': {'description': 'The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts. Managed enables a central contract to define a policy that allows certain callers to access certain functions.', 'anyOf': [{'type': 'string', 'enum': ['ownable', 'roles']}, {'type': 'string', 'const': 'managed'}]}, 'burnable': {'type': 'boolean', 'description': 'Whether token holders will be able to destroy their tokens'}, 'callback': {'type': 'boolean', 'description': 'Whether to include support for code execution after transfers and approvals on recipient contracts in a single transaction.'}, 'crossChainBridging': {'type': 'string', 'description': 'Whether to allow authorized bridge contracts to mint and burn tokens for cross-chain transfers. Options are to use custom bridges on any chain, or the SuperchainERC20 standard with the predeployed SuperchainTokenBridge. Emphasize that these features are experimental, not audited and are subject to change. The SuperchainERC20 feature is only available on chains in the Superchain, and requires deploying your contract to the same address on every chain in the Superchain.', 'enum': ['custom', 'superchain']}, 'flashmint': {'type': 'boolean', 'description': "Whether to include built-in flash loans to allow lending tokens without requiring collateral as long as they're returned in the same transaction."}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'mintable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to create more supply or emit more tokens'}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'pausable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to pause specifically marked functionality. Useful for emergency response.'}, 'permit': {'type': 'boolean', 'description': 'Whether without paying gas, token holders will be able to allow third parties to transfer from their account.'}, 'premint': {'type': 'string', 'description': 'The number of tokens to premint for the deployer.'}, 'premintChainId': {'type': 'string', 'description': 'The chain ID of the network on which to premint tokens.'}, 'symbol': {'type': 'string', 'description': 'The short symbol for the token'}, 'upgradeable': {'type': 'string', 'description': 'Whether the smart contract is upgradeable. Transparent uses more complex proxy with higher overhead, requires less changes in your contract. Can also be used with beacons. UUPS uses simpler proxy with less overhead, requires including extra code in your contract. Allows flexibility for authorizing upgrades.', 'enum': ['transparent', 'uups']}, 'votes': {'type': 'string', 'description': 'Whether to keep track of historical balances for voting in on-chain governance. Voting durations can be expressed as block numbers or timestamps.', 'enum': ['blocknumber', 'timestamp']}}, 'required': ['name', 'symbol'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-solidity
|
other
|
{'type': 'function', 'name': 'solidity-erc721', 'description': 'Make a non-fungible token per the ERC-721 standard.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'access': {'description': 'The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts. Managed enables a central contract to define a policy that allows certain callers to access certain functions.', 'anyOf': [{'type': 'string', 'enum': ['ownable', 'roles']}, {'type': 'string', 'const': 'managed'}]}, 'baseUri': {'type': 'string', 'description': 'A base uri for the token'}, 'burnable': {'type': 'boolean', 'description': 'Whether token holders will be able to destroy their tokens'}, 'enumerable': {'type': 'boolean', 'description': 'Whether to allow on-chain enumeration of all tokens or those owned by an account. Increases gas cost of transfers.'}, 'incremental': {'type': 'boolean', 'description': 'Whether new tokens will be automatically assigned an incremental id'}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'mintable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to create more supply or emit more tokens'}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'pausable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to pause specifically marked functionality. Useful for emergency response.'}, 'symbol': {'type': 'string', 'description': 'The short symbol for the token'}, 'upgradeable': {'type': 'string', 'description': 'Whether the smart contract is upgradeable. Transparent uses more complex proxy with higher overhead, requires less changes in your contract. Can also be used with beacons. UUPS uses simpler proxy with less overhead, requires including extra code in your contract. Allows flexibility for authorizing upgrades.', 'enum': ['transparent', 'uups']}, 'uriStorage': {'type': 'boolean', 'description': 'Allows updating token URIs for individual token IDs'}, 'votes': {'type': 'string', 'description': 'Whether to keep track of individual units for voting in on-chain governance. Voting durations can be expressed as block numbers or timestamps (defaulting to block number if not specified).', 'enum': ['blocknumber', 'timestamp']}}, 'required': ['name', 'symbol'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-solidity
|
other
|
{'type': 'function', 'name': 'solidity-governor', 'description': 'Make a contract to implement governance, such as for a DAO.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'blockTime': {'type': 'number', 'description': 'The block time of the chain, default is 12'}, 'clockMode': {'type': 'string', 'description': 'The clock mode used by the voting token. For Governor, this must be chosen to match what the ERC20 or ERC721 voting token uses.', 'enum': ['blocknumber', 'timestamp']}, 'decimals': {'type': 'number', 'description': 'The number of decimals to use for the contract, default is 18 for ERC20Votes and 0 for ERC721Votes (because it does not apply to ERC721Votes)'}, 'delay': {'type': 'string', 'description': 'The delay since proposal is created until voting starts, default is "1 day"'}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'period': {'type': 'string', 'description': 'The length of period during which people can cast their vote, default is "1 week"'}, 'proposalThreshold': {'type': 'string', 'description': 'Minimum number of votes an account must have to create a proposal, default is 0.'}, 'quorumAbsolute': {'type': 'string', 'description': 'The absolute quorum required, in cases of quorumMode equals absolute'}, 'quorumMode': {'type': 'string', 'description': 'The type of quorum mode to use', 'enum': ['percent', 'absolute']}, 'quorumPercent': {'type': 'number', 'description': 'The percent required, in cases of quorumMode equals percent'}, 'settings': {'type': 'boolean', 'description': 'Allow governance to update voting settings (delay, period, proposal threshold)'}, 'storage': {'type': 'boolean', 'description': 'Enable storage of proposal details and enumerability of proposals'}, 'timelock': {'description': 'The type of timelock to use', 'anyOf': [{'type': ['boolean', 'string'], 'enum': [False, 'openzeppelin']}, {'type': 'string', 'const': 'compound'}]}, 'upgradeable': {'type': 'string', 'description': 'Whether the smart contract is upgradeable. Transparent uses more complex proxy with higher overhead, requires less changes in your contract. Can also be used with beacons. UUPS uses simpler proxy with less overhead, requires including extra code in your contract. Allows flexibility for authorizing upgrades.', 'enum': ['transparent', 'uups']}, 'votes': {'type': 'string', 'description': 'The type of voting to use', 'enum': ['erc20votes', 'erc721votes']}}, 'required': ['name', 'delay', 'period'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-solidity
|
other
|
{'type': 'function', 'name': 'solidity-rwa', 'description': 'Make a real-world asset token that uses the ERC-20 standard. Experimental, some features are not audited and are subject to change.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'access': {'description': 'The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts. Managed enables a central contract to define a policy that allows certain callers to access certain functions.', 'anyOf': [{'type': 'string', 'enum': ['ownable', 'roles']}, {'type': 'string', 'const': 'managed'}]}, 'burnable': {'type': 'boolean', 'description': 'Whether token holders will be able to destroy their tokens'}, 'callback': {'type': 'boolean', 'description': 'Whether to include support for code execution after transfers and approvals on recipient contracts in a single transaction.'}, 'crossChainBridging': {'type': 'string', 'description': 'Whether to allow authorized bridge contracts to mint and burn tokens for cross-chain transfers. Options are to use custom bridges on any chain, or the SuperchainERC20 standard with the predeployed SuperchainTokenBridge. Emphasize that these features are experimental, not audited and are subject to change. The SuperchainERC20 feature is only available on chains in the Superchain, and requires deploying your contract to the same address on every chain in the Superchain.', 'enum': ['custom', 'superchain']}, 'custodian': {'type': 'boolean', 'description': 'Whether authorized accounts can freeze and unfreeze accounts for regulatory or security purposes. This feature is experimental, not audited and is subject to change.'}, 'flashmint': {'type': 'boolean', 'description': "Whether to include built-in flash loans to allow lending tokens without requiring collateral as long as they're returned in the same transaction."}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'limitations': {'description': 'Whether to restrict certain users from transferring tokens, either via allowing or blocking them. This feature is experimental, not audited and is subject to change.', 'anyOf': [{'type': ['boolean', 'string'], 'enum': [False, 'allowlist']}, {'type': 'string', 'const': 'blocklist'}]}, 'mintable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to create more supply or emit more tokens'}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'pausable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to pause specifically marked functionality. Useful for emergency response.'}, 'permit': {'type': 'boolean', 'description': 'Whether without paying gas, token holders will be able to allow third parties to transfer from their account.'}, 'premint': {'type': 'string', 'description': 'The number of tokens to premint for the deployer.'}, 'premintChainId': {'type': 'string', 'description': 'The chain ID of the network on which to premint tokens.'}, 'symbol': {'type': 'string', 'description': 'The short symbol for the token'}, 'votes': {'type': 'string', 'description': 'Whether to keep track of historical balances for voting in on-chain governance. Voting durations can be expressed as block numbers or timestamps.', 'enum': ['blocknumber', 'timestamp']}}, 'required': ['name', 'symbol'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-solidity
|
other
|
{'type': 'function', 'name': 'solidity-stablecoin', 'description': 'Make a stablecoin token that uses the ERC-20 standard. Experimental, some features are not audited and are subject to change.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'access': {'description': 'The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts. Managed enables a central contract to define a policy that allows certain callers to access certain functions.', 'anyOf': [{'type': 'string', 'enum': ['ownable', 'roles']}, {'type': 'string', 'const': 'managed'}]}, 'burnable': {'type': 'boolean', 'description': 'Whether token holders will be able to destroy their tokens'}, 'callback': {'type': 'boolean', 'description': 'Whether to include support for code execution after transfers and approvals on recipient contracts in a single transaction.'}, 'crossChainBridging': {'type': 'string', 'description': 'Whether to allow authorized bridge contracts to mint and burn tokens for cross-chain transfers. Options are to use custom bridges on any chain, or the SuperchainERC20 standard with the predeployed SuperchainTokenBridge. Emphasize that these features are experimental, not audited and are subject to change. The SuperchainERC20 feature is only available on chains in the Superchain, and requires deploying your contract to the same address on every chain in the Superchain.', 'enum': ['custom', 'superchain']}, 'custodian': {'type': 'boolean', 'description': 'Whether authorized accounts can freeze and unfreeze accounts for regulatory or security purposes. This feature is experimental, not audited and is subject to change.'}, 'flashmint': {'type': 'boolean', 'description': "Whether to include built-in flash loans to allow lending tokens without requiring collateral as long as they're returned in the same transaction."}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'limitations': {'description': 'Whether to restrict certain users from transferring tokens, either via allowing or blocking them. This feature is experimental, not audited and is subject to change.', 'anyOf': [{'type': ['boolean', 'string'], 'enum': [False, 'allowlist']}, {'type': 'string', 'const': 'blocklist'}]}, 'mintable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to create more supply or emit more tokens'}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'pausable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to pause specifically marked functionality. Useful for emergency response.'}, 'permit': {'type': 'boolean', 'description': 'Whether without paying gas, token holders will be able to allow third parties to transfer from their account.'}, 'premint': {'type': 'string', 'description': 'The number of tokens to premint for the deployer.'}, 'premintChainId': {'type': 'string', 'description': 'The chain ID of the network on which to premint tokens.'}, 'symbol': {'type': 'string', 'description': 'The short symbol for the token'}, 'votes': {'type': 'string', 'description': 'Whether to keep track of historical balances for voting in on-chain governance. Voting durations can be expressed as block numbers or timestamps.', 'enum': ['blocknumber', 'timestamp']}}, 'required': ['name', 'symbol'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-stellar
|
other
|
{'type': 'function', 'name': 'stellar-fungible', 'description': 'Make a fungible token per the Fungible Token Standard, compatible with SEP-41, similar to ERC-20.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'access': {'type': 'string', 'description': 'The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts.', 'enum': ['ownable', 'roles']}, 'burnable': {'type': 'boolean', 'description': 'Whether token holders will be able to destroy their tokens'}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'mintable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to create more supply or emit more tokens'}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'pausable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to pause specifically marked functionality. Useful for emergency response.'}, 'premint': {'type': 'string', 'description': 'The number of tokens to premint for the deployer.'}, 'symbol': {'type': 'string', 'description': 'The short symbol for the token'}, 'upgradeable': {'type': 'boolean', 'description': 'Whether the contract can be upgraded.'}}, 'required': ['name', 'symbol'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-stellar
|
other
|
{'type': 'function', 'name': 'stellar-non-fungible', 'description': 'Make a non-fungible token per the Non-Fungible Token Standard, compatible with SEP-50, similar to ERC-721.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'access': {'type': 'string', 'description': 'The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts.', 'enum': ['ownable', 'roles']}, 'burnable': {'type': 'boolean', 'description': 'Whether token holders will be able to destroy their tokens'}, 'consecutive': {'type': 'boolean', 'description': 'To batch mint NFTs instead of minting them individually (sequential minting is mandatory).'}, 'enumerable': {'type': 'boolean', 'description': 'Whether the NFTs are enumerable (can be iterated over).'}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'mintable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to create more supply or emit more tokens'}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'pausable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to pause specifically marked functionality. Useful for emergency response.'}, 'sequential': {'type': 'boolean', 'description': 'Whether the IDs of the minted NFTs will be sequential.'}, 'symbol': {'type': 'string', 'description': 'The short symbol for the token'}, 'upgradeable': {'type': 'boolean', 'description': 'Whether the contract can be upgraded.'}}, 'required': ['name', 'symbol'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-stellar
|
other
|
{'type': 'function', 'name': 'stellar-stablecoin', 'description': 'Make a stablecoin that uses Fungible Token Standard, compatible with SEP-41.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'access': {'type': 'string', 'description': 'The type of access control to provision. Ownable is a simple mechanism with a single account authorized for all privileged actions. Roles is a flexible mechanism with a separate role for each privileged action. A role can have many authorized accounts.', 'enum': ['ownable', 'roles']}, 'burnable': {'type': 'boolean', 'description': 'Whether token holders will be able to destroy their tokens'}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'limitations': {'description': 'Whether to restrict certain users from transferring tokens, either via allowing or blocking them.', 'anyOf': [{'type': ['boolean', 'string'], 'enum': [False, 'allowlist']}, {'type': 'string', 'const': 'blocklist'}]}, 'mintable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to create more supply or emit more tokens'}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'pausable': {'type': 'boolean', 'description': 'Whether privileged accounts will be able to pause specifically marked functionality. Useful for emergency response.'}, 'premint': {'type': 'string', 'description': 'The number of tokens to premint for the deployer.'}, 'symbol': {'type': 'string', 'description': 'The short symbol for the token'}, 'upgradeable': {'type': 'boolean', 'description': 'Whether the contract can be upgraded.'}}, 'required': ['name', 'symbol'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-stylus
|
other
|
{'type': 'function', 'name': 'stylus-erc1155', 'description': 'Make a non-fungible token per the ERC-1155 standard.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'burnable': {'type': 'boolean', 'description': 'Whether token holders will be able to destroy their tokens'}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'supply': {'type': 'boolean', 'description': 'Whether to keep track of total supply of tokens'}}, 'required': ['name'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-stylus
|
other
|
{'type': 'function', 'name': 'stylus-erc20', 'description': 'Make a fungible token per the ERC-20 standard.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'burnable': {'type': 'boolean', 'description': 'Whether token holders will be able to destroy their tokens'}, 'flashmint': {'type': 'boolean', 'description': "Whether to include built-in flash loans to allow lending tokens without requiring collateral as long as they're returned in the same transaction."}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'name': {'type': 'string', 'description': 'The name of the contract'}, 'permit': {'type': 'boolean', 'description': 'Whether without paying gas, token holders will be able to allow third parties to transfer from their account.'}}, 'required': ['name'], 'additionalProperties': False}, 'strict': True}
|
openzeppelin-stylus
|
other
|
{'type': 'function', 'name': 'stylus-erc721', 'description': 'Make a non-fungible token per the ERC-721 standard.\n\nReturns the source code of the generated contract, formatted in a Markdown code block. Does not write to disk.', 'parameters': {'type': 'object', 'properties': {'burnable': {'type': 'boolean', 'description': 'Whether token holders will be able to destroy their tokens'}, 'enumerable': {'type': 'boolean', 'description': 'Whether to allow on-chain enumeration of all tokens or those owned by an account. Increases gas cost of transfers.'}, 'info': {'type': 'object', 'description': 'Metadata about the contract and author', 'properties': {'license': {'type': 'string', 'description': 'The license used by the contract, default is "MIT"'}, 'securityContact': {'type': 'string', 'description': 'Email where people can contact you to report security issues. Will only be visible if contract source code is verified.'}}, 'additionalProperties': False}, 'name': {'type': 'string', 'description': 'The name of the contract'}}, 'required': ['name'], 'additionalProperties': False}, 'strict': True}
|
opik
|
other
|
{'type': 'function', 'name': 'create-project', 'description': 'Create a new project/workspace', 'parameters': {'type': 'object', 'properties': {'description': {'type': 'string', 'description': 'Description of the project'}, 'name': {'type': 'string', 'description': 'Name of the project'}, 'workspaceName': {'type': 'string', 'description': 'Workspace name to use instead of the default'}}, 'required': ['name'], 'additionalProperties': False}, 'strict': True}
|
opik
|
other
|
{'type': 'function', 'name': 'create-prompt', 'description': 'Create a new prompt', 'parameters': {'type': 'object', 'properties': {'name': {'type': 'string', 'description': 'Name of the prompt'}}, 'required': ['name'], 'additionalProperties': False}, 'strict': True}
|
opik
|
other
|
{'type': 'function', 'name': 'create-prompt-version', 'description': 'Create a new version of a prompt', 'parameters': {'type': 'object', 'properties': {'commit_message': {'type': 'string', 'description': 'Commit message for the prompt version'}, 'name': {'type': 'string', 'description': 'Name of the original prompt'}, 'template': {'type': 'string', 'description': 'Template content for the prompt version'}}, 'required': ['name', 'template', 'commit_message'], 'additionalProperties': False}, 'strict': True}
|
opik
|
other
|
{'type': 'function', 'name': 'delete-project', 'description': 'Delete a project', 'parameters': {'type': 'object', 'properties': {'projectId': {'type': 'string', 'description': 'ID of the project to delete'}, 'workspaceName': {'type': 'string', 'description': 'Workspace name to use instead of the default'}}, 'required': ['projectId'], 'additionalProperties': False}, 'strict': True}
|
opik
|
other
|
{'type': 'function', 'name': 'delete-prompt', 'description': 'Delete a prompt', 'parameters': {'type': 'object', 'properties': {'promptId': {'type': 'string', 'description': 'ID of the prompt to delete'}}, 'required': ['promptId'], 'additionalProperties': False}, 'strict': True}
|
opik
|
other
|
{'type': 'function', 'name': 'get-metrics', 'description': 'Get metrics data', 'parameters': {'type': 'object', 'properties': {'endDate': {'type': 'string', 'description': 'End date in ISO format (YYYY-MM-DD)'}, 'metricName': {'type': 'string', 'description': 'Optional metric name to filter'}, 'projectId': {'type': 'string', 'description': 'Optional project ID to filter metrics'}, 'projectName': {'type': 'string', 'description': 'Optional project name to filter metrics'}, 'startDate': {'type': 'string', 'description': 'Start date in ISO format (YYYY-MM-DD)'}}, 'required': [], 'additionalProperties': False}, 'strict': True}
|
opik
|
other
|
{'type': 'function', 'name': 'get-opik-examples', 'description': "Get examples of how to use Opik Comet's API for specific tasks", 'parameters': {'type': 'object', 'properties': {'task': {'type': 'string', 'description': "The task to get examples for (e.g., 'create prompt', 'analyze traces', 'monitor costs')"}}, 'required': ['task'], 'additionalProperties': False}, 'strict': True}
|
opik
|
other
|
{'type': 'function', 'name': 'get-opik-help', 'description': "Get contextual help about Opik Comet's capabilities", 'parameters': {'type': 'object', 'properties': {'subtopic': {'type': 'string', 'description': 'Optional subtopic for more specific help'}, 'topic': {'type': 'string', 'description': 'The topic to get help about (prompts, projects, traces, metrics, or general)'}}, 'required': ['topic'], 'additionalProperties': False}, 'strict': True}
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.