Provides tools for managing Maverick sites on Appian's platform, including creating new sites, querying existing sites, retrieving site details, performing maintenance actions (start, stop, restart), and modifying site configurations such as server size, region, and volume.
Maverick MCP Server
An MCP (Model Context Protocol) server for managing Maverick sites through Amazon Q CLI.
Features
- Create Sites: Create new Maverick sites with comprehensive configuration options
- Query Sites: Search and filter sites using various criteria
- Get Site Details: Retrieve detailed information about specific sites
Installation
- Install the package:
- Test the installation:
- Set up environment variables:
Configuration for Amazon Q CLI
Add to your Q CLI MCP configuration file at ~/.aws/amazonq/mcp.json
:
Note: Use the full path to your server.py file in the configuration.
Available Tools
1. maverick___create_site
Creates a new Maverick site with specified configuration.
Required Parameters:
subdomain
: The site name/subdomain
Optional Parameters:
installer
: Appian version (e.g., "22.1.235.0")installerLabel
: Installer label (e.g., "22.1-latest")region
: AWS region (e.g., "us-east-1")serverSize
: Server size (e.g., "m5.large")purpose
: Site purpose (development, hackathon, etc.)customerName
: Customer namedryRun
: Validate without creating (boolean)- And many more configuration options...
2. maverick___query_sites
Query sites using various filters and criteria.
Filter Options:
siteList
: Array of site IDspurpose
: Array of purposes to filter byregion
: Array of regions to filter byaccountName
: Array of account namescreatedAfter
: Sites created after specified timecreatedBefore
: Sites created before specified timemodifiedAfter
: Sites modified after specified timestatus
: Site status (Active, Shutdown, etc.)labelName
+labelValue
: Filter by labelsstartIndex
: Pagination start (default: 1)batchSize
: Results per page (default: 20)
3. maverick___get_site_by_id
Get detailed information about a specific site.
Parameters:
identifier
: Site ID (numeric) or site name/subdomain
4. maverick___manage_site
Perform various actions on existing Maverick sites.
Required Parameters:
identifier
: Site ID (numeric) or site name/subdomainaction
: Action to perform
Supported Actions:
start
: Start a stopped siterestart
: Restart a running sitestop
: Stop a running site (data persists)force-stop
: Force stop (bypasses standard checks)force-restart
: Force restart (force stop + start)delete
: Permanently delete a siterevert
: Revert site to a specific snapshoton-demand-backup
: Take an on-demand backupedit
: Edit site configurationclone
: Create a copy of the sitemove
: Move site to different regionresize
: Increase site volume size
Action-Specific Parameters:
- Edit:
installer
,serverSize
,purpose
,siteProperties
, etc. - Revert:
restoreSpec
(withsiteID
andcreatedAt
) - Clone:
reason
,requestorFirstName
,requestorLastName
,requestorEmail
,supportCase
- Move:
region
,email
(optional) - Resize:
volumeSize
5. maverick___get_site_resize_status
Check the status of an ongoing site resize operation.
Parameters:
siteId
: Site ID to check resize status for
Usage Examples
Create a Simple Site
Create an Advanced Site
Query Sites by Purpose
Query Sites by Region
Query Recent Sites
Get Specific Site
Query with Pagination
Site Management Actions
Edit Site Configuration
Clone Site
Move and Resize Sites
Testing
Run the test script to verify everything is working:
This will test all three tools and show you what to expect.
Response Format
The server provides formatted, human-readable responses with:
- ✅ Success indicators
- ❌ Error indicators
- 📊 Structured site information with emojis for easy reading
- Pagination information when applicable
- Total count of matching results
Error Handling
The server handles various error scenarios:
- Missing API tokens
- Validation errors (400)
- Not found errors (404)
- Server errors (500)
- Network timeouts
- Invalid parameters
Files in this Project
server.py
- Main MCP server implementation with all 5 toolsrequirements.txt
- Python dependenciessetup.py
- Package configurationtest_server.py
- Test script to verify all functionalitytest_auth.py
- Authentication testing scriptq-config-example.json
- Example Q CLI configurationREADME.md
- This documentation
Next Steps
- Get your Maverick API token from your Maverick instance
- Set the environment variables with your actual token
- Add the MCP server configuration to
~/.aws/amazonq/mcp.json
- Restart Amazon Q CLI and test with:
q chat
- Try the example commands to verify everything works
Development
To extend the server with additional Maverick APIs:
- Add new tool definitions to
handle_list_tools()
- Add corresponding handlers to
handle_call_tool()
- Implement the API call functions
- Update this README with the new functionality
Environment Variables
MAVERICK_BASE_URL
: Base URL for Maverick API (default: staging)MAVERICK_API_TOKEN
: Authentication token for Maverick API (required)
Note: The server uses the appian-api-key
header for authentication, which is one of the supported methods in Maverick API. Other supported methods include:
appian-api-key
header (used by this server)Authorization: Bearer
header- Basic Authentication with null username
- Basic Authentication with null password
Authentication Setup
To get your API token:
- Configure object security for a service account in your Maverick instance
- Generate an API key for that service account
- Set the
MAVERICK_API_TOKEN
environment variable with your key
Example:
Dependencies
mcp>=1.10.0
: Model Context Protocol libraryhttpx>=0.25.0
: Async HTTP client- Python 3.8+
This server cannot be installed
An MCP server that enables Amazon Q CLI users to create, query, and manage Maverick sites through natural language commands.
Related MCP Servers
- AsecurityFlicenseAqualityA Model Context Protocol (MCP) server that enables AI assistants like Claude to interact with your AWS environment. This allows for natural language querying and management of your AWS resources during conversations. Think of better Amazon Q alternative.Last updated -3264TypeScript
- -securityAlicense-qualityAn MCP server that allows managing Docker containers through natural language, enabling users to compose, introspect, and debug containers without running commands themselves.Last updated -468PythonGPL 3.0
- -securityAlicense-qualityA lightweight service that enables AI assistants to execute AWS CLI commands through the Model Context Protocol (MCP), allowing AI tools to retrieve AWS documentation and interact with AWS services.Last updated -57PythonMIT License
- -securityFlicense-qualityAn MCP server that enables Claude to generate and execute AWS CLI commands, allowing users to manage AWS resources through natural language conversations.Last updated -1TypeScript