BedrockAgentCoreControl / Client / create_registry_record

create_registry_record¶

BedrockAgentCoreControl.Client.create_registry_record(**kwargs)¶

Creates a new registry record within the specified registry. A registry record represents an individual AI resource’s metadata in the registry. This could be an MCP server (and associated tools), A2A agent, agent skill, or a custom resource with a custom schema.

The record is processed asynchronously and returns HTTP 202 Accepted.

Request Syntax

response = client.create_registry_record(
    registryId='string',
    name='string',
    description='string',
    descriptorType='MCP'|'A2A'|'CUSTOM'|'AGENT_SKILLS',
    descriptors={
        'mcp': {
            'server': {
                'schemaVersion': 'string',
                'inlineContent': 'string'
            },
            'tools': {
                'protocolVersion': 'string',
                'inlineContent': 'string'
            }
        },
        'a2a': {
            'agentCard': {
                'schemaVersion': 'string',
                'inlineContent': 'string'
            }
        },
        'custom': {
            'inlineContent': 'string'
        },
        'agentSkills': {
            'skillMd': {
                'inlineContent': 'string'
            },
            'skillDefinition': {
                'schemaVersion': 'string',
                'inlineContent': 'string'
            }
        }
    },
    recordVersion='string',
    synchronizationType='URL',
    synchronizationConfiguration={
        'fromUrl': {
            'url': 'string',
            'credentialProviderConfigurations': [
                {
                    'credentialProviderType': 'OAUTH'|'IAM',
                    'credentialProvider': {
                        'oauthCredentialProvider': {
                            'providerArn': 'string',
                            'grantType': 'CLIENT_CREDENTIALS',
                            'scopes': [
                                'string',
                            ],
                            'customParameters': {
                                'string': 'string'
                            }
                        },
                        'iamCredentialProvider': {
                            'roleArn': 'string',
                            'service': 'string',
                            'region': 'string'
                        }
                    }
                },
            ]
        }
    },
    clientToken='string'
)

Parameters:

registryId (string) –
[REQUIRED]

The identifier of the registry where the record will be created. You can specify either the Amazon Resource Name (ARN) or the ID of the registry.
name (string) –
[REQUIRED]

The name of the registry record.
description (string) – A description of the registry record.
descriptorType (string) –
[REQUIRED]

The descriptor type of the registry record.
- MCP - Model Context Protocol descriptor for MCP-compatible servers and tools.
- A2A - Agent-to-Agent protocol descriptor.
- CUSTOM - Custom descriptor type for resources such as APIs, Lambda functions, or servers not conforming to a standard protocol.
- AGENT_SKILLS - Agent skills descriptor for defining agent skill definitions.
descriptors (dict) –
The descriptor-type-specific configuration containing the resource schema and metadata. The structure of this field depends on the descriptorType you specify.
- mcp (dict) –
  
  The Model Context Protocol (MCP) descriptor configuration. Use this when the descriptorType is MCP.
  - server (dict) –
    
    The MCP server definition, containing the server configuration and schema as defined by the MCP protocol specification.
    - schemaVersion (string) –
      
      The schema version of the server definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.
    - inlineContent (string) –
      
      The JSON content containing the MCP server definition, conforming to the MCP protocol specification.
  - tools (dict) –
    
    The MCP tools definition, containing the tools available on the MCP server as defined by the MCP protocol specification.
    - protocolVersion (string) –
      
      The protocol version of the tools definition based on the MCP protocol specification. If not specified, the version is auto-detected from the content.
    - inlineContent (string) –
      
      The JSON content containing the MCP tools definition, conforming to the MCP protocol specification.
- a2a (dict) –
  
  The Agent-to-Agent (A2A) protocol descriptor configuration. Use this when the descriptorType is A2A.
  - agentCard (dict) –
    
    The agent card definition for the A2A agent, as defined by the A2A protocol specification.
    - schemaVersion (string) –
      
      The schema version of the agent card based on the A2A protocol specification.
    - inlineContent (string) –
      
      The JSON content containing the A2A agent card definition, conforming to the A2A protocol specification.
- custom (dict) –
  
  The custom descriptor configuration. Use this when the descriptorType is CUSTOM.
  - inlineContent (string) –
    
    The custom descriptor content as a valid JSON document. You can define any custom schema that describes your resource.
- agentSkills (dict) –
  
  The agent skills descriptor configuration. Use this when the descriptorType is AGENT_SKILLS.
  - skillMd (dict) –
    
    The optional skill markdown definition describing the agent’s skills in a human-readable format.
    - inlineContent (string) –
      
      The markdown content describing the agent’s skills in a human-readable format.
  - skillDefinition (dict) –
    
    The structured skill definition with schema version and content.
    - schemaVersion (string) –
      
      The version of the skill definition schema.
    - inlineContent (string) –
      
      The JSON content containing the structured skill definition.
recordVersion (string) – The version of the registry record. Use this to track different versions of the record’s content.
synchronizationType (string) – The type of synchronization to use for keeping the record metadata up to date from an external source. Possible values include FROM_URL and NONE.
synchronizationConfiguration (dict) –
The configuration for synchronizing registry record metadata from an external source, such as a URL-based MCP server.
- fromUrl (dict) –
  
  Configuration for synchronizing from a URL-based source.
  - url (string) – [REQUIRED]
    
    The HTTPS URL of the MCP server to synchronize from.
  - credentialProviderConfigurations (list) –
    
    Optional list of credential provider configurations for authenticating with the MCP server. At most one credential provider configuration can be specified.
    - (dict) –
      
      A pairing of a credential provider type with its corresponding provider details for authenticating with external sources.
      - credentialProviderType (string) – [REQUIRED]
        
        The type of credential provider.
        
        OAUTH - OAuth-based authentication.
        
        IAM - Amazon Web Services IAM-based authentication using SigV4 signing.
      - credentialProvider (dict) – [REQUIRED]
        
        The credential provider configuration details. The structure depends on the credentialProviderType.
        
        Note
        This is a Tagged Union structure. Only one of the following top level keys can be set: oauthCredentialProvider, iamCredentialProvider.
        
        oauthCredentialProvider (dict) –
        
        The OAuth credential provider configuration for authenticating with the external source.
        
        providerArn (string) – [REQUIRED]
        
        The Amazon Resource Name (ARN) of the OAuth credential provider resource.
        
        grantType (string) –
        
        The OAuth grant type. Currently only CLIENT_CREDENTIALS is supported.
        
        scopes (list) –
        
        The OAuth scopes to request during authentication.
        
        (string) –
        
        customParameters (dict) –
        
        Additional custom parameters for the OAuth flow.
        
        (string) –
        
        (string) –
        
        iamCredentialProvider (dict) –
        
        The IAM credential provider configuration for authenticating with the external source using SigV4 signing.
        
        roleArn (string) –
        
        The Amazon Resource Name (ARN) of the IAM role to assume for SigV4 signing.
        
        service (string) –
        
        The SigV4 signing service name (for example, execute-api or bedrock-agentcore).
        
        region (string) –
        
        The Amazon Web Services region for SigV4 signing (for example, us-west-2). If not specified, the region is extracted from the MCP server URL hostname, with fallback to the service’s own region.
clientToken (string) –
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don’t specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn’t return an error. For more information, see Ensuring idempotency.

This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'recordArn': 'string',
    'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED'|'CREATING'|'UPDATING'|'CREATE_FAILED'|'UPDATE_FAILED'
}

Response Structure

(dict) –
- recordArn (string) –
  
  The Amazon Resource Name (ARN) of the created registry record.
- status (string) –
  
  The status of the registry record. Set to CREATING while the asynchronous workflow is in progress.

Exceptions

BedrockAgentCoreControl.Client.exceptions.ServiceQuotaExceededException
BedrockAgentCoreControl.Client.exceptions.AccessDeniedException
BedrockAgentCoreControl.Client.exceptions.ConflictException
BedrockAgentCoreControl.Client.exceptions.ValidationException
BedrockAgentCoreControl.Client.exceptions.ResourceNotFoundException
BedrockAgentCoreControl.Client.exceptions.ThrottlingException
BedrockAgentCoreControl.Client.exceptions.InternalServerException