aura-property-setup-mcp
v1.0.1
Published
MCP server for editing Aura property setup via API
Readme
Aura Property Setup MCP Server
This project provides a Model Context Protocol (MCP) server with a tool to edit property details via the Aura/HotelBox API.
Features
editPropertyTool: Allows updating property details using a PATCH request to thehttps://brain.hotelbox.ai/api/v1/setup/properties/{propertyId}endpoint.
Prerequisites
- Node.js and pnpm (or npm/yarn) installed.
- An API Access Token for the Aura/HotelBox API.
Installation
- Clone the repository or download the source code.
- Navigate to the
propertySetupdirectory:cd propertySetup - Install dependencies:
pnpm install # or npm install / yarn install
Building
To compile the TypeScript code into JavaScript, run:
pnpm run build
# or npm run build / yarn buildThis will create a dist directory containing the compiled code.
Running the Server
To start the MCP server, run the build command first, then execute the start script:
# Build the project (if not already built)
pnpm run build
# or npm run build / yarn build
# Start the server
pnpm start
# or npm start / yarn start
# Alternatively, run the compiled code directly:
node dist/server.jsThe server will start and listen for MCP connections via standard input/output (stdio).
Important: When calling the editProperty tool, the API access token must be included in the arguments payload alongside propertyId and the payload object containing the fields to update.
Example Tool Call Arguments:
{
"propertyId": "1",
"accessToken": "YOUR_API_ACCESS_TOKEN",
"payload": {
"category": "Boutique",
"contactNumber": "+19876543210"
// ... other fields to update
}
}Project Structure
propertySetup/
├── dist/ # Compiled JavaScript output (after build)
├── node_modules/ # Project dependencies
├── src/ # TypeScript source code
│ ├── config.ts # Configuration (API URL, argument parsing)
│ ├── server.ts # Main MCP server setup and startup
│ ├── utils.ts # Utility functions (e.g., error handling)
│ └── tools/ # Directory for MCP tool definitions
│ └── editProperty.ts # Logic for the editProperty tool
├── package.json # Project metadata and dependencies
├── pnpm-lock.yaml # Lockfile for pnpm
├── README.md # This file
└── tsconfig.json # TypeScript compiler configuration