How to connect Breezy HR MCP with TypeScript

Get the currently authenticated Breezy HR user.

List the companies the authenticated Breezy HR user belongs to, with each company's ID, name, friendly_id and its position and member counts. Use list_positions, get_position_team, list_pipelines and the other company tools for the details.

List all companies available to the authenticated Breezy HR user. Returns company IDs needed for other API calls.

Get details for a specific Breezy HR company by ID. Use list_companies first to get available company IDs.

List all pipelines for a Breezy HR company. Returns an array of pipeline objects each containing a stages array. Stage id values (e.g. "applied", "interviewing") are what set_candidate_stage and move_candidate expect.

Get the stages for a specific pipeline. Returns { pipeline_id, stages: [...] }. Use list_pipelines first to get pipeline IDs and see all pipelines at once. Stage id values (e.g. "applied", "interviewing") are what set_candidate_stage and move_candidate expect.

List questionnaires available for a Breezy HR company.

Get details for a specific company questionnaire including its questions.

List email templates available for a Breezy HR company.

Get details for a specific company email template.

Get the custom attribute definitions for candidates in a Breezy HR company.

Get the custom attribute definitions for positions in a Breezy HR company.

Use this when the user asks about their jobs or job openings ("what jobs do I have open", "my line cook job"), or to find the position_id another tool needs. Lists positions (job openings) for a Breezy HR company. Use list_companies first to get a company_id.

Get details for a specific position (job opening) in Breezy HR.

Get team members assigned to a specific position in Breezy HR.

Get the activity stream for a specific position in Breezy HR. Returns one page of 30 events, newest first. To read further back, call again with skip set to the number of events already received (30, 60, ...); a page with fewer than 30 events is the last one.

Get custom fields defined on a specific position in Breezy HR.

Create a new position (job opening) in Breezy HR.

Use this when the user wants to change a job that already exists, such as its title, description, pay or location. Updates an existing position in Breezy HR. Only include fields you want to change.

Use this when the user wants to open, close or archive a job, for example once the role is filled. Changes the state of a position (e.g. publish, close, archive, draft).

Update a custom field value on a position. Use get_position_custom_fields to see available fields.

Use this to read who applied to a job for your own reasoning, such as counting applicants or finding a candidate by name. Lists candidates for a position in Breezy HR. Returns up to page_size candidates (default 50) with summary fields per candidate (name, email, stage, source, scores, tags); page through with page until a page comes back short. Pass stage_id to get only the candidates in one pipeline stage; the filter is applied server-side. For full details including work history, education, social profiles, and custom attributes use get_candidate. Requires a company_id and position_id. Use list_companies and list_positions to find these IDs.

Use this when you have a candidate's email address and need to find them across every job in a company. Searches by email address only; to find a candidate by name, use list_candidates on their job.

Get full details for a specific candidate including work history, education, social profiles, cover letter, and custom attributes. Use this when you need complete candidate information beyond what list_candidates returns.

Get rich metadata for a candidate including notes, scorecards, tasks, interviews, documents, and conversation history.

Get the activity stream for a specific candidate including notes, stage changes, and other events. Returns one page of 50 events. To read further back, call again with skip set to the number of events already received (50, 100, ...); the oldest event in the history carries first_activity: true, so a page containing it is the last one.

Get the conversation history for a specific candidate including messages between the candidate and hiring team.

Use this to read a candidate's resume. Returns the resume's text for PDF resumes, the most common format; for other formats, only the file type and size, since their text can't be read here. The details Breezy parsed from the resume (work history, education, summary) are in get_candidate.

Get documents attached to a specific candidate.

Get questionnaires and responses for a specific candidate.

Get third-party assessment results for a specific candidate.

Get background check results for a specific candidate.

Get custom field values for a specific candidate.

Use this when the user wants to add someone they found or were referred to as a candidate for a job and has no resume file. Creates a new candidate on a position in Breezy HR. Requires name. email_address is required when origin is "applied". Use add_candidate_by_resume if you have a resume file to parse instead.

Update fields on a candidate. Can change name, email, phone, summary, headline, address, tags, social profiles, source, and cover letter.

Update a custom field value on a candidate. Use get_candidate_custom_fields to see available fields and get_candidate_custom_attributes (company level) for field definitions.

Update education for a candidate. Requires school_name at minimum. Optional: degree, field_of_study, start_year, end_year.

Update work history for a candidate. Requires company_name at minimum. Optional: title, summary, start_year, start_month, end_year, end_month.

Set a custom attribute on a candidate. Custom attributes are name/value string pairs.

Use this when a candidate should be considered for a different job. Moves a candidate from one position to another. Requires the target position ID and target stage ID. To change their stage in the same job, use set_candidate_stage. The move is refused if a candidate with the same email address is already on the target position.

Use this when the user wants to move a candidate forward or back in the hiring process, for example to interviewing, offer or hired, or to reject them (disqualified). Moves a candidate to a different pipeline stage. Use get_pipeline to see available stage IDs.

Use this when the user wants to record feedback or a private note about a candidate, such as interview impressions. Adds an internal note to a candidate's activity stream. Notes are visible to the hiring team only, never to the candidate.

Use this when the user wants to contact a candidate, for example to ask their availability, invite them to interview or follow up. Sends a message to a candidate via the conversation thread. This message is visible to the candidate.

Use this when the user wants to rate a candidate or record a hiring vote ("strong yes on Elena"). Adds a scorecard rating for a candidate. Score must be one of: very_good, good, neutral, poor, very_poor.

Use this when the user wants a candidate to answer screening or follow-up questions. Sends a questionnaire to a candidate. Use list_company_questionnaires to find questionnaire IDs.

Submit responses for a candidate questionnaire. Use get_candidate_questionnaires to see pending questionnaires and their question IDs.

Use this when the user has a resume file and wants to add that person as a candidate for a job. Creates a new candidate by uploading and parsing a resume file. The resume bytes must be base64-encoded. Supported formats: pdf, doc, docx, txt, rtf, html.

Attach a document file to an existing candidate. The file bytes must be base64-encoded. Per Breezy docs, this is also how you add a resume to an existing candidate.

List all webhook endpoints configured for a Breezy HR company.

Get details for a specific webhook endpoint including its URL, events, and status.

Create a new webhook endpoint for a Breezy HR company. Webhooks notify your URL when events occur (e.g. candidate stage changes).

Update an existing webhook endpoint. Can change URL, events, description, or enabled status.

Permanently delete a webhook endpoint. This cannot be undone.

Pause a webhook endpoint. The endpoint will stop receiving events until resumed.

Resume a paused webhook endpoint. The endpoint will start receiving events again.