vikey-mcp-server
An MCP (Model Context Protocol) server that exposes the Vikey API to any MCP-compatible AI client (Cursor, Claude Desktop, etc.).
Tools
| Tool | Description |
|---|---|
list_external_reservations |
Retrieve reservations via the external endpoint (/ext/reservations) |
list_reservations |
Retrieve all reservations with optional filters (/reservations) |
list_locals |
List properties / apartments (/locals) |
get_reservation_detail |
Get full detail of a single reservation (/v3/resv/resv) |
get_reservation_services |
Get services / payment info for a reservation (/v3/pay/services) |
Requirements
- Python ≥ 3.10
- A valid Vikey API key
Installation
Via uvx (recommended – no install needed)
uvx vikey-mcp-server
Via pip
pip install vikey-mcp-server
vikey-mcp-server
Configuration
Set the VIKEY_API_KEY environment variable before starting the server:
export VIKEY_API_KEY=your_api_key_here
Cursor / Claude Desktop integration
Add the following block to your MCP client configuration file.
Cursor (~/.cursor/mcp.json or .cursor/mcp.json in the project):
{
"mcpServers": {
"vikey": {
"command": "uvx",
"args": ["vikey-mcp-server"],
"env": {
"VIKEY_API_KEY": "your_api_key_here"
}
}
}
}
Claude Desktop (~/Library/Application Support/Claude/claude_desktop_config.json):
{
"mcpServers": {
"vikey": {
"command": "uvx",
"args": ["vikey-mcp-server"],
"env": {
"VIKEY_API_KEY": "your_api_key_here"
}
}
}
}
Tool reference
list_external_reservations
| Parameter | Type | Required | Description |
|---|---|---|---|
last_updated |
string |
No | Return reservations updated after this date (YYYY-MM-DD) |
checkin_status |
string |
No | NONEED · WAIT · PEND · OK |
list_reservations
| Parameter | Type | Required | Description |
|---|---|---|---|
checkin_status |
string |
No | NONEED · WAIT · PEND · OK |
last_updated |
string |
No | Return reservations updated after this date (YYYY-MM-DD) |
external_key |
string |
No | External key identifying the apartment |
integr_ref |
string |
No | Reservation external key from a Vikey integration |
list_locals
| Parameter | Type | Required | Description |
|---|---|---|---|
date_from |
string |
No | Apartments created from this date (YYYY-MM-DD) |
date_to |
string |
No | Apartments created up to this date (YYYY-MM-DD) |
installed |
integer |
No | 1 = installed only · 0 = not installed only |
local_key |
string |
No | Unique identifier of a specific apartment |
get_reservation_detail
| Parameter | Type | Required | Description |
|---|---|---|---|
resv_key |
string |
Yes | Reservation identifier (e.g. 29FG3DI6) |
get_reservation_services
| Parameter | Type | Required | Description |
|---|---|---|---|
resv_key |
string |
Yes | Reservation identifier (e.g. 29FG3DI6) |
Development
# Clone and install
git clone https://github.com/tosettil/vikey-mcp-server.git
cd vikey-mcp-server
uv sync
# Run locally
VIKEY_API_KEY=your_key uv run vikey-mcp-server
Release workflow
Releases are automated via GitHub Actions. Use the Bump version workflow from the Actions tab to choose patch, minor, or major. The workflow will:
- Bump the version in
pyproject.toml - Create and push the corresponding
vX.Y.Ztag - The tag push triggers the Publish workflow, which builds and pushes the package to PyPI
One-time setup
- PyPI Trusted Publisher: on pypi.org, configure a trusted publisher for this project pointing at
tosettil-polimi/vikey-mcp-server, workflowpublish.yml. NoPYPI_API_TOKENis required. RELEASE_PATrepository secret: create a fine-grained Personal Access Token withcontents: writepermission on this repo and add it as theRELEASE_PATsecret. This is required because pushes made with the defaultGITHUB_TOKENdo not trigger other workflows (GitHub's anti-loop protection), so without a PAT the tag pushed bybump-version.ymlwould never triggerpublish.yml.
License
MIT
Metadata
Release files for vikey-mcp-server 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| vikey_mcp_server-0.1.3.tar.gz | 4.0 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| vikey_mcp_server-0.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 8.6 kB
Release files / vikey_mcp_server-0.1.3.tar.gz
| Download URL | vikey_mcp_server-0.1.3.tar.gz |
|---|---|
| Size | 4.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b713b23209405e00e48c880599080b0112f1dfdd4debb24a1638c03ff79e3dc8
|
|
BLAKE2b-256 checksum How to use checksums |
ca8dc989a1b3ae3992b6ac8da1e6fd2848f1a548a50bf90cd23cf5c10f5e45ea
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 5, 2026.
Transparency logRelease files / vikey_mcp_server-0.1.3-py3-none-any.whl
| Download URL | vikey_mcp_server-0.1.3-py3-none-any.whl |
|---|---|
| Size | 4.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ea0f35c48ccb0a2be856cc7755360d4332a4d4c7a1dbc3f028c13c7170bcc16b
|
|
BLAKE2b-256 checksum How to use checksums |
aba60ed4bc048b5d5c2af52dfbdfd7138b93da983d2857a0ff086d9a17aead59
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 5, 2026.
Transparency logSecurity for vikey-mcp-server 0.1.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for vikey_mcp_server-0.1.3.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 5, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.