Amazon Bedrock AgentCore

Searches for registry records using semantic, lexical, or hybrid queries. Returns metadata for matching records ordered by relevance within the specified registry.

See also: AWS API Documentation

Request Syntax

client.search_registry_records(
    searchQuery='string',
    registryIds=[
        'string',
    ],
    maxResults=123,
    filters={...}|[...]|123|123.4|'string'|True|None
)

type searchQuery:

string

param searchQuery:

[REQUIRED]

The search query to find matching registry records.

type registryIds:

list

param registryIds:

[REQUIRED]

The list of registry identifiers to search within. Currently, you can specify exactly one registry identifier. You can provide either the full Amazon Web Services Resource Name (ARN) or the 12-character alphanumeric registry ID.

• (string) --

type maxResults:

integer

param maxResults:

The maximum number of records to return in a single call. Valid values are 1 through 20. The default value is 10.

type filters:

:ref:`document<document>`

param filters:

A metadata filter expression to narrow search results. Uses structured JSON operators including field-level operators ( $eq, $ne, $in) and logical operators ( $and, $or) on filterable fields ( name, descriptorType, version). For example, to filter by descriptor type: {"descriptorType": {"$eq": "MCP"}}. To combine filters: {"$and": [{"descriptorType": {"$eq": "MCP"}}, {"name": {"$eq": "my-tool"}}]}.

rtype:

dict

returns:

Response Syntax

{
    'registryRecords': [
        {
            'registryArn': 'string',
            'recordArn': 'string',
            'recordId': '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'
                    }
                }
            },
            'version': 'string',
            'status': 'DRAFT'|'PENDING_APPROVAL'|'APPROVED'|'REJECTED'|'DEPRECATED',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

• (dict) --

  • registryRecords (list) --

    The list of registry records that match the search query, ordered by relevance.

    • (dict) --

      Summary information about a registry record.

      • registryArn (string) --

        The Amazon Resource Name (ARN) of the registry that this record belongs to.

      • recordArn (string) --

        The Amazon Resource Name (ARN) of the registry record.

      • recordId (string) --

        The unique identifier of the registry record.

      • name (string) --

        The name of the registry record.

      • description (string) --

        A description of the registry record.

      • descriptorType (string) --

        The type of descriptor associated with this registry record.

      • descriptors (dict) --

        The descriptor configurations for this registry record.

        • mcp (dict) --

          The MCP (Model Context Protocol) descriptor configuration. Populated when the record's descriptorType is MCP.

          • server (dict) --

            The MCP server definition that describes the server configuration.

            • schemaVersion (string) --

              The schema version of the MCP server configuration. The schema version identifies the format of the server definition content.

            • inlineContent (string) --

              The inline content of the server definition.

          • tools (dict) --

            The MCP tools definition that describes the available tools.

            • protocolVersion (string) --

              The MCP protocol version that the tools conform to. This differs from the schemaVersion field in the server definition, which identifies the server configuration schema format.

            • inlineContent (string) --

              The inline content of the tools definition.

        • a2a (dict) --

          The A2A (Agent-to-Agent) descriptor configuration. Populated when the record's descriptorType is A2A.

          • agentCard (dict) --

            The agent card definition that describes the agent's capabilities and interface.

            • schemaVersion (string) --

              The schema version of the agent card definition.

            • inlineContent (string) --

              The inline content of the agent card definition.

        • custom (dict) --

          The custom descriptor configuration. Populated when the record's descriptorType is CUSTOM.

          • inlineContent (string) --

            The inline content of the custom descriptor.

        • agentSkills (dict) --

          The agent skills descriptor configuration. Populated when the record's descriptorType is AGENT_SKILLS.

          • skillMd (dict) --

            The skill description in markdown format.

            • inlineContent (string) --

              The inline markdown content of the skill definition.

          • skillDefinition (dict) --

            The structured skill definition with a schema version and content.

            • schemaVersion (string) --

              The schema version of the skill definition. If you don't specify a version, the service detects it automatically.

            • inlineContent (string) --

              The inline content of the skill definition.

      • version (string) --

        The version of the registry record.

      • status (string) --

        The current status of the registry record.

      • createdAt (datetime) --

        The date and time when the registry record was created.

      • updatedAt (datetime) --

        The date and time when the registry record was last updated.