The Birdeye MCP Server connects AI assistants like Claude and ChatGPT directly to your Birdeye account using the Model Context Protocol (MCP) — an open standard for secure, real-time access to external data. Point your AI client at https://mcp.birdeye.com/mcp, authorize with your Birdeye credentials, and start asking natural-language questions about your reviews, listings, surveys, social performance, and more. This repo contains the documentation site, built with Mintlify.
📖 Live Docs: URL to be added once hosting is finalized
MCP Server URL: https://mcp.birdeye.com/mcp
| Category | Tools |
|---|---|
| Reviews | Get reviews, get review summary, review & rating overview |
| Reports | Review conversion, rating trends, source and visitor counts, NPS, usage, dashboard, response rate and time, rating distribution |
| Business | Get business info, get child locations |
| Surveys | Get all surveys, get survey responses |
| Listings | Get listing, listing status report, listing insights, category list, product listing list |
| Search AI | Configuration, available runs, citations, businesses, accuracy report, sentiment report |
| Social | Track social post, get open URL performance report |
| Ticketing | Get all ticket data |
| Aggregation | Get all aggregation sources, get review site aliases |
- Add
https://mcp.birdeye.com/mcpas a connector in your AI client (Claude or ChatGPT) - Authorize with your Birdeye credentials via OAuth 2.0
- Start asking questions about your Birdeye data
Full setup instructions: quickstart.mdx
.
├── docs.json # Mintlify navigation and theme config
├── introduction.mdx # Landing page
├── quickstart.mdx # Setup guide for Claude, ChatGPT, and other clients
├── authentication.mdx # OAuth 2.0 flow details
├── images/ # Logos and assets
└── tools/ # Tool reference docs
├── overview.mdx
├── reviews/
├── reports/
├── business/
├── surveys/
├── listings/
├── search-ai/
├── social/
├── ticketing/
└── aggregation/
Install the Mintlify CLI and run a local preview:
npm install -g mintlify
mintlify devThe docs will be available at http://localhost:3000.
Use api/openapi.yaml as the source of truth for API reference content. For each new operation:
-
Add the path and HTTP method with a unique
operationId,summary, and the complete description, including every note, warning, default behavior, and field interaction. -
Document every path/query/header parameter with its type, required state, description, and example. Give
Acceptanexampleand matchingschema.default. Add the same editable default for JSONContent-Typeonly when the operation has an actual JSON request body; do not add it to bodyless GET operations. -
Add the complete
requestBodyschema: media type, required fields, nested fields, descriptions, formats/enums, and a realistic example. -
Add every documented response status with its complete schema and example. Do not leave array
itemsor objectpropertiesempty when the source documents their fields. -
Create a small endpoint page in the relevant API folder:
--- title: "Endpoint title" openapi: "api/openapi.yaml GET /v1/resource/{resourceId}" ---
-
Add that page to the appropriate API group in
docs.json. -
Run the migration audit when API Blueprint is the source, then validate and preview the site:
ruby tools/audit_apib_migration.rb --sync-examples /path/to/apiary.apib api/openapi.yaml ruby tools/audit_apib_migration.rb /path/to/apiary.apib api/openapi.yaml mintlify validate mintlify broken-links mintlify dev
-
In the preview, check the description/notes, parameter tables, request and response field trees, examples, generated code, and editable prefilled headers in “Try it”.
To report a security vulnerability, please do not open a public GitHub issue. Instead:
- Email security@birdeye.com
- Visit trust.birdeye.com for our security policies and disclosure program
For questions about the MCP server or this documentation, reach out to: