1. MCP
WinCloud API
  • Getting Started
    • Introduction
    • Quick Start
    • Authentication
    • General
    • Changelog
    • Privacy Policy
    • Terms of Service
    • Support
  • APIs
    • Guests
      • Search Guests
      • Create Guest
      • Get Guest Details
      • Update Guest
      • Get Guest Reservations
      • Get Guest Reference Data
    • Inventory
      • Get Room Inventory
      • Get Room Inventory Details
      • Update Room Inventory
    • Properties
      • Get Customer Properties
      • Get Property Configuration
    • Rates
      • Get Rate Adjustment Templates
      • Get Master Rates
      • Post Master Rates
      • Post Individual Rates
    • Reference Data
      • Get Countries
      • Get Payment Gateways
      • Get Payment Methods
      • Get Currencies
    • Reservations v1
      • Get Reservations
      • Get Cancelled Reservations
      • Get No-Show Reservations
      • Get Reservation Statuses
      • Update Special Instructions
    • Reservations v2
      • List Reservations
      • Get Reservation
    • Rooms
      • Get Rooms
      • Get Room Types
      • Get Rooms Extra Charges
      • Get Rooms Feature Types
      • Get Rooms Tariffs
      • Get Room and Revenue Performance
    • Travel Agents
      • Get Active Travel Agents
    • POS
      • Get Outlet Menu
    • Booking Analytics
      • Get Arrival Summary
      • Get Booking Summary
    • Schemas
      • CodeNameDto
      • ArrivalFiguresDto
      • CompanyDto
      • ArrivalSummaryDto
      • CompanyDtoPaginatedResponse
      • ArrivalSummaryDtoApiResponse
      • CompanyDtoPaginatedResponseApiResponse
      • BookingSummaryDto
      • CountryDto
      • ConfigurationOutletDto
      • BookingSummaryDtoApiResponse
      • CountryDtoApiResponse
      • ConfigurationRoomTypeDto
      • CountryRefDto
      • CurrencyDto
      • CurrencyDtoPaginatedResponse
      • CurrencyDtoPaginatedResponseApiResponse
      • ExtraChargeDto
      • ExtraChargeDtoApiResponse
      • FeatureTypeDto
      • CurrencyRefDto
      • FeatureTypeDtoPaginatedResponse
      • FeatureTypeDtoPaginatedResponseApiResponse
      • GuestCreatedDto
      • GuestAddressDto
      • GuestCreatedDtoApiResponse
      • GuestLookupsDto
      • GuestLookupsDtoApiResponse
      • DepartureFiguresDto
      • GuestPhoneDto
      • GuestPreferencesDto
      • GuestProfileDtoApiResponse
      • GuestProfileDto
      • GuestReservationDtoPaginatedResponse
      • GuestReservationDtoPaginatedResponseApiResponse
      • GuestStaySummaryDto
      • GuestReservationDto
      • GuestProfileRequestDto
      • GuestSummaryItemDto
      • GuestSummaryItemDtoPaginatedResponse
      • GuestPassportDto
      • GuestSummaryItemDtoPaginatedResponseApiResponse
      • InventoryRoomTypeDto
      • InventorySnapshotDto
      • InventorySnapshotDtoPaginatedResponse
      • InventorySnapshotDtoPaginatedResponseApiResponse
      • LanguageRefDto
      • MasterRateBlockDto
      • MasterRateTypeDto
      • MasterRateTypeDtoPaginatedResponse
      • MasterRateTypeDtoPaginatedResponseApiResponse
      • LinkedGuestDto
      • MealPlanDto
      • ObjectApiResponse
      • PayMethodDto
      • PayMethodDtoPaginatedResponse
      • OtaReferenceDto
      • PayMethodDtoPaginatedResponseApiResponse
      • PaymentGatewayDto
      • PaymentGatewayDtoPaginatedResponse
      • PaymentGatewayDtoPaginatedResponseApiResponse
      • ProblemDetails
      • PosMenuItemDto
      • RateAdjustmentTemplateDto
      • PosMenuItemDtoPaginatedResponse
      • RateAdjustmentTemplateDtoPaginatedResponse
      • PosMenuItemDtoPaginatedResponseApiResponse
      • RateAdjustmentTemplateDtoPaginatedResponseApiResponse
      • RatePlanRefDto
      • RecentReservationsDto
      • ReservationBillingDto
      • ReservationCancellationDto
      • PropertyConfigurationDto
      • ReservationEventDtoPaginatedResponse
      • PropertyConfigurationDtoApiResponse
      • ReservationEventDtoPaginatedResponseApiResponse
      • ReservationSourceDto
      • ReservationStatusDto
      • ReservationDtoApiResponse
      • ReservationDtoListApiResponse
      • ReservationStatusDtoListApiResponse
      • ReservationDtoPaginatedResponse
      • ReservationStayStatusDto
      • ReservationDtoPaginatedResponseApiResponse
      • RoomAssignmentItemDto
      • ReservationBookingDto
      • RoomCheckInDto
      • RoomCheckOutDto
      • RoomDto
      • RoomDtoPaginatedResponse
      • RoomDtoPaginatedResponseApiResponse
      • ReservationEventDto
      • RoomInventoryUpdateRequestDto
      • RoomInventoryUpdateResponseDto
      • RoomInventoryUpdateResponseDtoApiResponse
      • RoomRateDto
      • ReservationDto
      • RoomRateDtoPaginatedResponse
      • RoomRateDtoPaginatedResponseApiResponse
      • ReservationRoomDto
      • RoomRateFailureDto
      • RoomRateItemDto
      • RoomRateUpdateRequestDto
      • RoomRateUpdateResponseDto
      • RoomRateUpdateResponseDtoApiResponse
      • ReservationGuestDto
      • RoomTypeDto
      • ReservationOccupancyDto
      • RoomTypeDtoPaginatedResponse
      • RoomTypeDtoPaginatedResponseApiResponse
      • RoomTypeRefDto
      • StaySpendDto
      • TemplateDateRangeDto
      • TitleRefDto
      • TravelAgentDto
      • RoomPerformanceComparisonDto
      • TravelAgentDtoPaginatedResponse
      • RoomPerformanceMetricsDto
      • TravelAgentDtoPaginatedResponseApiResponse
      • RoomPerformancePeriodDto
      • UpdateMasterRatesRequestDto
      • RoomPerformanceResponseDto
      • UpdateMasterRatesResultDto
      • RoomPerformanceResponseDtoApiResponse
      • UpdateMasterRatesResultDtoApiResponse
      • UpdateReservationRequestDto
      • UpdateReservationResponseDtoApiResponse
      • RoomTypePerformanceDto
      • UpdateReservationResponseDto
      • SpecialRequestsDto
  • MCP
    • Overview
    • Connect Your AI Assistant
  • Webhooks
    • Set Up and Edit Webhooks
    • Verify Webhook Signatures
    • List of Webhook Events
  1. MCP

Connect Your AI Assistant

Add WinCloud to Claude, ChatGPT, Codex or another AI assistant as a custom MCP server, sign in, and check it works. This takes about five minutes.

Before you start#

A WinCloud user account with access to the hotels you need, and the permissions for the tools you want to use. See Permissions.
An AI assistant that supports custom MCP servers. The tabs below cover Claude, Claude Code, ChatGPT and Codex, with a fallback for other assistants.
The server address: https://api.wincloudone.com/mcp. The steps below write it as {mcp_url}.

Step 1: Add the server to your assistant#

Claude
Claude Code
ChatGPT
Codex
Other assistants
Works in Claude on the web and in Claude Desktop. Every Claude plan can add a custom connector; the Free plan is limited to one.
1
Open the connector settings
On Pro and Max, go to Customize → Connectors, select + Add, then Add custom connector. On Team and Enterprise, an organisation owner goes to Organization settings → Connectors → Add → Custom → Web.
Claude connector settings with the Add custom connector option
2
Enter the server address
Enter a name, for example WinCloud, and enter {mcp_url} as the URL. Select Continue.
Claude Add custom connector dialog with the name and server address
3
Choose how to sign in
Under Authentication, keep Sign in now. Under OAuth client, keep Register automatically. Select Add.
Claude authentication and OAuth client options
4
Connect
Open WinCloud in your connector list, select Connect, then sign in as described in Step 2. On Team and Enterprise, each member then finds WinCloud in their own connector settings and selects Connect to sign in with their own account.
Claude connector page with the Connect button
Vendor guide: Getting started with custom connectors

Step 2: Sign in and allow access#

Your assistant opens the WinCloud sign-in page in your browser. You sign in there with your own WinCloud user account, never in the assistant itself.
1
Sign in to WinCloud
Enter your property ID, username and WinCloud password, then select Sign in.
WinCloud sign-in page
2
Review the permissions
The next screen lists what the assistant is asking to read. It shows only permissions your account already has. Under Locations it can use, select the hotels the assistant may read. The screen may say the app registered itself and has not been checked by RBS. This is expected when you add WinCloud yourself; continue only if you started the connection.
WinCloud permissions screen with Locations it can use
3
Allow access
Select Allow. Your browser returns to your assistant and the tools you are allowed to use appear. Select Deny to cancel.
Claude connector list showing WinCloud connected
The server checks your sign-in before it runs any tool. If your sign-in expires, your assistant asks you to sign in again.

Step 3: Check the connection#

Ask your assistant: "Which hotels can I see in WinCloud?" If it lists your hotels and their company codes, the connection works. This check needs no particular permission.
For developers: test with MCP Inspector

Permissions#

Each permission is called a scope. Your sign-in includes the scopes your WinCloud account has been granted, and a tool is listed only when your sign-in includes its scope.
ScopeToolsLets you
reservations:readsearch_bookings, get_reservation, get_reservation_analyticsRead bookings and booking analytics
rates:readget_rate_plans, list_master_rates, get_rate_configuration, list_rate_templates, search_room_tariffs, list_room_types, list_rooms, list_room_featuresRead rate setup, nightly tariffs and rooms
inventory:readget_inventorySee today's room status
guests:readsearch_guests, get_guest_reservationsFind guests and their stays
Nonelist_companiesList the hotels your sign-in covers
For example, a sign-in with only rates:read lists the rate and room tools plus list_companies, and no others. list_companies needs no scope of its own, but you need at least one of the other scopes to connect at all.
CAUTION
Your sign-in covers only the hotels your account can access. Asking for another hotel returns "You don't have access to company" followed by the company code.

Keep tool approval on#

CAUTION
An AI assistant can be steered by instructions hidden in the data it reads. This is called prompt injection. Answers can contain guest names and booking details. Keep your assistant's tool-approval setting on, and check what it does with the answers before you share them.
Modified at 2026-11-02 15:24:29
Previous
Overview
Next
Set Up and Edit Webhooks
Built with