Skip to main content
Glama

candidate_list_notes

Retrieve all notes for a specific candidate in the Ashby hiring pipeline to track application history and interview feedback.

Instructions

List all notes for a candidate.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
candidateIdYesThe candidate ID
limitNoMax results per page
cursorNoCursor for next page

Implementation Reference

  • The handle_call_tool function is the handler that executes all tools defined in the server, including candidate_list_notes, by routing to the appropriate Ashby API endpoint using the TOOL_ENDPOINT_MAP.
    @server.call_tool()
    async def handle_call_tool(name: str, arguments: dict[str, Any]) -> list[types.TextContent]:
        """Route tool calls to the correct Ashby endpoint, passing arguments directly."""
        endpoint = TOOL_ENDPOINT_MAP.get(name)
        if not endpoint:
            return [types.TextContent(type="text", text=f"Unknown tool: {name}")]
    
        try:
            # Pass arguments straight through -- tool schemas already use Ashby's
            # camelCase param names so no translation is needed.
            response = ashby.post(endpoint, data=arguments if arguments else None)
            return [types.TextContent(type="text", text=json.dumps(response, indent=2))]
        except requests.exceptions.HTTPError as e:
            error_body = ""
            if e.response is not None:
                try:
                    error_body = e.response.text
                except Exception:
                    pass
            return [
                types.TextContent(
                    type="text",
                    text=f"Ashby API error on {endpoint}: {e}\n{error_body}",
                )
            ]
        except Exception as e:
            return [types.TextContent(type="text", text=f"Error calling {endpoint}: {e}")]
  • The candidate_list_notes tool is defined and registered in the TOOLS list, including its input schema.
    types.Tool(
        name="candidate_list_notes",
        description="List all notes for a candidate.",
        inputSchema={
            "type": "object",
            "properties": {
                "candidateId": {"type": "string", "description": "The candidate ID"},
                "limit": {"type": "integer", "description": "Max results per page"},
                "cursor": {"type": "string", "description": "Cursor for next page"},
            },
            "required": ["candidateId"],
        },
    ),
  • The TOOL_ENDPOINT_MAP maps the candidate_list_notes tool name to the actual API endpoint '/candidate.listNotes'.
    TOOL_ENDPOINT_MAP = {
        "job_list": "/job.list",
        "job_info": "/job.info",
        "job_search": "/job.search",
        "candidate_list": "/candidate.list",
        "candidate_search": "/candidate.search",
        "candidate_info": "/candidate.info",
        "candidate_create": "/candidate.create",
        "candidate_create_note": "/candidate.createNote",
        "candidate_list_notes": "/candidate.listNotes",
        "candidate_add_tag": "/candidate.addTag",
        "candidate_tag_list": "/candidateTag.list",
        "application_list": "/application.list",
        "application_info": "/application.info",
        "application_create": "/application.create",
        "application_change_stage": "/application.change_stage",
        "interview_stage_list": "/interviewStage.list",
        "interview_plan_list": "/interviewPlan.list",
        "interview_list": "/interview.list",
        "interview_info": "/interview.info",
        "department_list": "/department.list",
        "user_list": "/user.list",
        "source_list": "/source.list",
        "archive_reason_list": "/archiveReason.list",
        "location_list": "/location.list",
    }
Behavior2/5

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

No annotations are provided, so the description carries full burden for behavioral disclosure. It states it's a list operation, implying read-only behavior, but lacks details on permissions, rate limits, pagination (beyond schema hints), error handling, or what 'notes' entail (e.g., format, content). This is inadequate for a tool with parameters and no output schema.

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 a single, efficient sentence with zero wasted words. It's front-loaded with the core purpose ('List all notes for a candidate'), making it easy to parse quickly. Every word earns its place, achieving ideal conciseness.

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

Completeness2/5

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

Given no annotations, no output schema, and 3 parameters (with 100% schema coverage), the description is incomplete. It doesn't explain what 'notes' are, how they're returned, or behavioral aspects like pagination or errors. For a list tool in a candidate management context, more context is needed to guide effective use.

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?

Schema description coverage is 100%, so the schema fully documents parameters (candidateId, limit, cursor). The description adds no additional meaning beyond implying 'candidateId' is required for listing notes, which is already clear from the schema. Baseline 3 is appropriate as the schema does the heavy lifting.

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

Purpose4/5

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

The description clearly states the action ('List all notes') and resource ('for a candidate'), making the purpose immediately understandable. However, it doesn't differentiate from potential sibling tools like 'candidate_info' or 'candidate_create_note' that might also involve candidate notes, leaving room for improvement in specificity.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. With sibling tools like 'candidate_info' (which might include notes) and 'candidate_create_note' (for adding notes), there's no indication of context, prerequisites, or exclusions, leaving the agent to guess based on tool names alone.

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/PlenishAI/mcp-ashby'

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