Content
# Aliyun MCP Server User Guide
## [README of English](README-EN.md)
## 📚 Table of Contents
- [Overview](#overview)
- [Deployment Modes](#deployment-modes)
- [Remote Mode](#remote-mode)
- [Local Mode](#local-mode)
- [Detailed Explanation of Remote Mode](#detailed-explanation-of-remote-mode)
- [Technical Specifications](#technical-specifications)
- [Access Address](#access-address)
- [System MCP Service List](#system-mcp-service-list)
- [Infrastructure Management](#infrastructure-management)
- [Monitoring and Auditing](#monitoring-and-auditing)
- [Compliance and Governance](#compliance-and-governance)
- [Core Capabilities](#core-capabilities)
- [OpenAPI Customization and Optimization](#openapi-customization-and-optimization)
- [Terraform As Tools](#terraform-as-tools)
- [Multi-Account Support](#multi-account-support)
- [Custom OAuth](#custom-oauth)
- [Detailed Explanation of Local Mode](#detailed-explanation-of-local-mode)
- [Operating Mechanism](#operating-mechanism)
- [Service List](#service-list)
- [Database Services](#database-services)
- [Data Analysis Services](#data-analysis-services)
- [DevOps Services](#devops-services)
- [Other Services](#other-services)
- [Quick Start](#quick-start)
- [Remote Mode Access](#remote-mode-access)
- [Local Mode Deployment](#local-mode-deployment)
- [Reference Documentation](#reference-documentation)
## Overview
Aliyun MCP Server is a powerful cloud service integration platform that provides seamless integration capabilities for Aliyun services to AI applications through the Model Context Protocol (MCP). This platform supports tens of thousands of Aliyun OpenAPIs, allowing developers to easily integrate various Aliyun service capabilities into AI workflows.
## Deployment Modes
### Remote Mode
Use the fully managed OpenAPI MCP Server hosted by Aliyun without local deployment to access the full range of Aliyun services. Suitable for scenarios requiring rapid integration and low maintenance costs.
### Local Mode
Run MCP Server locally based on the stdio process mode. Suitable for scenarios with high data security requirements and requiring custom configurations.
## Detailed Explanation of Remote Mode
### Technical Specifications
- **Supported Protocols**: SSE (Server-Sent Events), Streamable HTTP
- **Authentication Method**: OAuth 2.0
- **Number of APIs**: Supports tens of thousands of Aliyun OpenAPIs
- **Deployment Method**: Cloud-hosted, zero maintenance
### Access Address
| Region | Access Address | Applicable Scenarios |
|------|---------|----------|
| **China Site** | https://api.aliyun.com/mcp | Users in Mainland China |
| **International Site** | https://api.alibabacloud.com/mcp | Overseas and international users |
### System MCP Service List
Aliyun officially provides a series of carefully tuned system MCP services optimized for specific scenarios:
#### Infrastructure Management
| Service Name | Function Description |
|---------|---------|
| **Terraform Provider** | Provides Aliyun Terraform Provider metadata, supporting online validation and runtime capabilities for executing Terraform commands |
| **Quota Center** | Query the general quota information of products supported by the quota center based on cloud product name, quota description, region information, etc. |
| **Resource Search** | Supports searching and statistical functions for resources with permissions under the current account |
#### Monitoring and Auditing
| Service Name | Function Description |
|---------|---------|
| **Operation Audit AI** | Use AI to flexibly call the LookupEvents interface of Operation Audit based on scenarios |
| **Permission Diagnosis** | When an API request is rejected due to lack of permissions, perform permission diagnosis through EncodedDiagnosticMessage |
#### Compliance and Governance
| Service Name | Function Description |
|---------|---------|
| **Governance Report** | MCP Server based on GovernanceReport |
| **Configuration Audit Compliance Package** | Query compliance package templates, enable specified compliance packages, and query risk overview and risk resource list |
### Core Capabilities
#### OpenAPI Customization and Optimization
- Modify API descriptions to make them more suitable for AI understanding
- Simplify non-required parameters to reduce call complexity
- Optimize parameter descriptions to improve AI call accuracy
#### Terraform As Tools
- **HCL Code Integration**: Introduce Terraform HCL code as a complete tool
- **Automatic Variable Parsing**: Automatically convert Terraform variables into tool parameters
- **Deterministic Orchestration**: Achieve deterministic deployment and management of infrastructure
#### Multi-Account Support
- **Role Assumption**: Automatically use role assumption capabilities to operate on specific accounts
- **Account Switching**: Flexibly specify the operation account and assumed role
- **Centralized Management**: Easily achieve multi-account AI integration management
#### Custom OAuth
- **Callback Whitelist**: Precisely control the callback address whitelist
- **Token Lifecycle**: Flexibly set the expiration time of access tokens and refresh tokens
- **Long-Term Login-Free**: Can achieve up to 1 year of login-free experience
## Detailed Explanation of Local Mode
### Operating Mechanism
Local mode is based on stdio process communication. MCP Server runs locally as an independent process and communicates with AI applications through standard input and output.
### Service List
#### Database Services
| Service | Repository Address | Description |
|------|---------|------|
| **DMS** | [alibabacloud-dms-mcp-server](https://github.com/aliyun/alibabacloud-dms-mcp-server) | Data Management Service, providing database management capabilities |
| **RDS** | [alibabacloud-rds-openapi-mcp-server](https://github.com/aliyun/alibabacloud-rds-openapi-mcp-server) | Relational Database Service OpenAPI integration |
| **ADBPG** | [alibabacloud-adbpg-mcp-server](https://github.com/aliyun/alibabacloud-adbpg-mcp-server) | AnalyticDB for PostgreSQL |
#### Data Analysis Services
| Service | Repository Address | Description |
|------|---------|------|
| **DataWorks** | [alibabacloud-dataworks-mcp-server](https://github.com/aliyun/alibabacloud-dataworks-mcp-server) | DataWorks, providing big data development and governance capabilities |
#### DevOps Services
| Service | Repository Address | Description |
|------|---------|------|
| **Cloud Effect** | [alibabacloud-devops-mcp-server](https://github.com/aliyun/alibabacloud-devops-mcp-server) | Enterprise-level DevOps platform integration |
| **O\&M Development** | [alibaba-cloud-ops-mcp-server](https://github.com/aliyun/alibaba-cloud-ops-mcp-server) | O\&M development tool integration |
#### Other Services
| Service | Repository Address | Description |
|------|---------|------|
| **ESA** | [mcp-server-esa](https://github.com/aliyun/mcp-server-esa) | Edge Security Acceleration Service |
| **Observability** | [alibabacloud-observability-mcp-server](https://github.com/aliyun/alibabacloud-observability-mcp-server) | Observability service integration |
## Quick Start
### Remote Mode Access
1. **Access the Console**
- China Site Users: https://api.aliyun.com/mcp
- International Site Users: https://api.alibabacloud.com/mcp
2. **OAuth Authentication**
- Configure OAuth Application
- Obtain Access Token
- Configure Token Refresh Policy
3. **Select Service**
- Browse System MCP Services
- Select the required OpenAPI
- Customize API Parameters
### Local Mode Deployment
1. **Clone Repository**
```bash
git clone https://github.com/aliyun/[Specific service repository name]
cd [Repository directory]
```
2. **Install Dependencies**
```bash
npm install # or yarn install
```
3. **Configure Authentication**
```bash
export ALIBABA_CLOUD_ACCESS_KEY_ID=your_access_key
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=your_secret_key
```
4. **Start Service**
```bash
npm start # or follow the startup instructions in the specific repository
```
## Reference Documentation
- 📖 **Official Documentation**: [OpenAPI MCP Server User Guide](https://help.aliyun.com/zh/openapi/user-guide/openapi-mcp-server-guide)
- 🔧 **Technical Support**: Obtain technical support through the Aliyun ticket system or official forum
- 💬 **Community Communication**: Join the Aliyun Developer Community to participate in discussions, DingTalk group: 136325002292
- Example of using through AgentScope <https://github.com/agentscope-ai/agentscope/tree/main/examples/alibabacloud_api_mcp>
---
*This document is continuously updated. You are welcome to submit Issues or PRs to contribute content*
