Skip to main content
Glama
needle-ai

Needle MCP Server

Official
by needle-ai

needle_get_collection_details

Fetch detailed metadata about a specific Needle collection to verify configuration, check status, and review attributes before performing operations.

Instructions

Fetch comprehensive metadata about a specific Needle collection. Provides detailed information about the collection's configuration, creation date, and current status. Use this tool when you need to: - Verify a collection's existence and configuration - Check collection metadata before operations - Get creation date and other attributes Requires a valid collection ID and returns detailed collection metadata. Will error if collection doesn't exist.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
collection_idYesThe unique collection identifier returned from needle_create_collection or needle_list_collections

Implementation Reference

  • Handler implementation for the 'needle_get_collection_details' tool within the call_tool dispatcher function. Validates input, calls NeedleClient.collections.get(), and formats the response.
    elif name == "needle_get_collection_details":
        if not isinstance(arguments, dict) or "collection_id" not in arguments:
            raise ValueError("Missing required parameter: 'collection_id'")
        collection = client.collections.get(arguments["collection_id"])
        result = {
            "collection": {
                "id": collection.id,
                "name": collection.name,
                "created_at": str(collection.created_at)
            }
        }
  • Tool registration in list_tools() including name, description, and input schema for 'needle_get_collection_details'.
    Tool(
        name="needle_get_collection_details",
        description="""Fetch comprehensive metadata about a specific Needle collection. 
        Provides detailed information about the collection's configuration, creation date, and current status.
        Use this tool when you need to:
        - Verify a collection's existence and configuration
        - Check collection metadata before operations
        - Get creation date and other attributes
        Requires a valid collection ID and returns detailed collection metadata. Will error if collection doesn't exist.""",
        inputSchema={
            "type": "object",
            "properties": {
                "collection_id": {
                    "type": "string",
                    "description": "The unique collection identifier returned from needle_create_collection or needle_list_collections"
                }
            },
            "required": ["collection_id"]
        }
    ),
  • Input schema definition for the 'needle_get_collection_details' tool, specifying required 'collection_id' parameter.
    inputSchema={
        "type": "object",
        "properties": {
            "collection_id": {
                "type": "string",
                "description": "The unique collection identifier returned from needle_create_collection or needle_list_collections"
            }
        },
        "required": ["collection_id"]
    }
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes the tool's behavior by stating it 'returns detailed collection metadata' and specifies error conditions ('Will error if collection doesn't exist'), though it lacks details on rate limits, authentication needs, or response format specifics.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately sized and front-loaded, starting with the core purpose, followed by usage guidelines in bullet points, and ending with prerequisites and error conditions. Every sentence adds value without redundancy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's moderate complexity (1 parameter, no output schema, no annotations), the description is largely complete, covering purpose, usage, prerequisites, and error handling. However, it could be enhanced by including details on the metadata structure returned or any performance considerations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema description coverage is 100%, so the schema already documents the single parameter (collection_id). The description adds minimal value beyond the schema by mentioning 'Requires a valid collection ID' but does not provide additional syntax or format details, meeting the baseline for high schema coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's purpose with specific verbs ('fetch comprehensive metadata') and resources ('specific Needle collection'), distinguishing it from siblings like needle_get_collection_stats (which likely provides statistics rather than configuration metadata) and needle_list_collections (which lists collections rather than fetching details of a specific one).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explicitly provides when-to-use guidance with three bullet points (e.g., 'Verify a collection's existence and configuration', 'Check collection metadata before operations'), and it specifies a prerequisite ('Requires a valid collection ID') and an error condition ('Will error if collection doesn't exist'), offering clear alternatives and exclusions.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/needle-ai/needle-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server