@明道云网/韩联社
HAP（Hyper Application Platform）是明道公司推出的APaaS平台(https://www.mingdao.com)这有助于您无需编码即可快速构建企业级应用程序。 这是HAP的MCP（模型上下文协议）服务器，用于无缝集成人工智能。
🚀 MCP客户端快速入门（例如光标）
1.配置光标MCP设置（需要Node.js 18+）
将以下配置添加到光标设置中：
选项A：标准配置（SaaS版本） 创建或编辑 ~/.cursor/mcp.json:
{
"mcpServers": {
"hap-mcp": {
"command": "npx",
"args": ["-y", "@mingdaocloud/hap-mcp"],
"env": {
"APPKEY": "your_APPKEY_here",
"SIGN": "your_signature_here"
}
}
}
}选项B：专用部署配置 仅适用于专用部署环境。创建 .cursor/mcp.json 在项目根目录中：
{
"mcpServers": {
"hap-mcp": {
"command": "npx",
"args": ["-y", "@mingdaocloud/hap-mcp"],
"env": {
"APPKEY": "your_APPKEY_here",
"SIGN": "your_signature_here",
"HOST": "https://www.nocoly.com"
}
}
}
}备注：The HOST 参数仅在专用部署环境中是必需的。替换 https://www.nocoly.com 使用您的实际私有部署服务器URL。
2.在光标中开始使用
配置后，在 hap-mcp 工具，您将可以直接在您的人工智能对话中访问所有HAP API工具！
📋 替代安装方法
# Run directly with npx
npx @mingdaocloud/hap-mcp🔭 包含什么
HAP提供：
- 具有stdio和HTTP传输选项的生产就绪MCP服务器
- 完成HAP API集成 -完全访问HAP应用程序API
- 用于常见AI集成任务的预构建工具
- 自定义工具、资源和提示的可扩展架构
- 完全类型安全的TypeScript支持
- 易于部署和配置
✨ 特性
- FastMCP框架：建立在强大的FastMCP框架之上
- 双重运输支持：通过stdio或HTTP运行，以获得最大的灵活性
- HAP API工具：HAP应用程序操作的全套工具
- TypeScript：企业级开发完全支持TypeScript
- 生产就绪：针对生产部署进行了优化
- 可扩展：易于扩展自定义功能
🔧 HAP API工具
hap-mcp 包括一整套与HAP应用程序交互的工具：
可用工具（28个工具）
核心工作表操作（9个工具）
- add_worksheet_record：向工作表添加新记录
- delete_worksheet_record：从工作表中删除记录
- update_worksheet_record：更新现有记录
- get_worksheet_fields：获取工作表字段信息
- list_worksheet_records：列出具有筛选和分页功能的记录
- list_工作表：列出应用程序中的所有工作表
- get_worksheet_pivot_data：通过聚合获取数据透视表数据
- 创建工作表：创建带有控件的新工作表
- get_worksheet_record_detail：获取特定记录的详细信息
批量操作（2个工具）
- add_worksheet_records_batch：批量创建多条记录
- update_worksheet_records_batch：批量更新多条记录
高级功能（5个工具）
- 获取app_info：获取应用程序信息，包括组、工作表和自定义页面
- 获取相关工作表记录：从链接的工作表中获取记录
- get_worksheet_record_share_link：为记录生成共享链接
- get_worksheet_record_count：获取工作表中的总记录数
- get_worksheet_record_logs：获取记录的操作历史
角色管理（7个工具）
- get_roles：列出应用程序角色
- create_role：创建具有权限的新角色
- 删除角色：删除角色
- add_role_members：将用户添加到角色
- remove_role_members：从角色中删除用户
- get_role_detail：获取详细的角色信息
- exit_app：从应用程序中删除某人
选项集管理（4个工具）
- create_option_set：创建新选项集
- get_option_set：获取选项集信息
- update_option_set：更新现有选项集
- delete_option_set：删除选项集
实用工具（1个工具）
- 获取rea_info：获取地理区域信息
快速示例
{
"tool": "list_worksheet_records",
"parameters": {
"worksheetId": "worksheet_id",
"pageSize": 50
}
}🚀 入门指南
创建项目后：
- 使用首选的包管理器安装依赖项：
# Using npm
npm install
# Using yarn
yarn
# Using pnpm
pnpm install
# Using bun
bun install- 启动服务器：
# Start the stdio server
npm start
# Or start the HTTP server
npm run start:http- 对于自动重新加载的开发：
# Development mode with stdio
npm run dev
# Development mode with HTTP
npm run dev:http备注package.json中的默认脚本使用Bun作为运行时（例如。， bun run src/index.ts).如果你更喜欢使用不同的包管理器或运行时，你可以在package.json文件中修改这些脚本，以使用Node.js或你选择的其他运行时。📖 详细用法
运输方式
MCP服务器支持两种传输方式：
- stdio运输 （命令行模式）：
- 运行在您的 本地计算机 - 由MCP客户端自动管理（例如游标） - 通过以下方式直接沟通 stdout - 仅限您在本地访问 - 个人发展和工具的理想选择
- SSE 运输 （HTTP Web模式）：
- 可以运行 本地或远程 - 由您管理和运营 - 沟通 通过网络 - 可以是 共享 跨机器 - 非常适合团队协作和共享工具
在本地运行服务器
stdio传输（CLI模式）
在CLI工具的stdio模式下启动服务器：
# Start the stdio server
npm start
# or with other package managers
yarn start
pnpm start
bun start
# Start the server in development mode with auto-reload
npm run dev
# or
yarn dev
pnpm dev
bun devHTTP传输（Web模式）
以HTTP模式启动web应用程序的服务器：
# Start the HTTP server
npm run start:http
# or
yarn start:http
pnpm start:http
bun start:http
# Start the HTTP server in development mode with auto-reload
npm run dev:http
# or
yarn dev:http
pnpm dev:http
bun dev:http默认情况下，HTTP服务器在端口3001上运行。您可以通过设置PORT环境变量来更改此设置：
# Start the HTTP server on a custom port
PORT=8080 npm run start:http连接到服务器
从游标连接
要从Cursor连接到MCP服务器，请执行以下操作：
- 打开光标并转到设置（左下角的齿轮图标）
- 点击左侧边栏中的“功能”
- 向下滚动到“MCP服务器”部分
- 点击“添加新的MCP服务器”
- 输入以下详细信息：
- 服务器名称： my-mcp-server （或您喜欢的任何名称） - 对于stdio模式： - 类型： command - 命令：指向服务器可执行文件的路径，例如。， npm start - 对于 SSE 模式： - 类型： url - 网址： http://localhost:3001/sse
- 点击“保存”
使用mcp.json和游标
要获得更便携的配置，请创建 .cursor/mcp.json 项目根目录中的文件：
标准配置（SaaS版本）：
{
"mcpServers": {
"hap-mcp": {
"command": "npx",
"args": ["-y", "@mingdaocloud/hap-mcp"],
"env": {
"APPKEY": "your_APPKEY_here",
"SIGN": "your_signature_here"
}
},
"my-mcp-sse": {
"url": "http://localhost:3001/sse"
}
}
}专用部署配置：
{
"mcpServers": {
"hap-mcp": {
"command": "npx",
"args": ["-y", "@mingdaocloud/hap-mcp"],
"env": {
"APPKEY": "your_APPKEY_here",
"SIGN": "your_signature_here",
"HOST": "https://www.nocoly.com"
}
},
"my-mcp-sse": {
"url": "http://localhost:3001/sse"
}
}
}您还可以在以下位置创建全局配置 ~/.cursor/mcp.json 使您的MCP服务器在所有Cursor工作区中可用。
环境变量：
APPKEY（必填）：您的明道应用密钥SIGN（必填）：您的明道签名HOST（可选）：仅用于私有部署的自定义主机URL（例如。，https://www.nocoly.com).如果提供，API调用将使用host/api而不是https://api.mingdao.com
注：
- 这
command类型条目以stdio模式运行服务器 - 这
url类型条目使用SSE传输连接到HTTP服务器 - 您可以使用以下命令提供环境变量
env领域 - 当通过SSE与FastMCP连接时，请使用完整的URL，包括
/sse路径：http://localhost:3001/sse
使用CLI工具测试服务器
FastMCP提供用于测试服务器的内置工具：
# Test with mcp-cli
npx fastmcp dev server.js
# Inspect with MCP Inspector
npx fastmcp inspect server.ts使用环境变量
您可以使用环境变量自定义服务器：
# Required Mingdao API credentials
export APPKEY="your_APPKEY_here"
export SIGN="your_signature_here"
# Optional custom host (for private deployment only)
export HOST="https://www.nocoly.com"
# Server configuration
# Change the HTTP port (default is 3001)
PORT=8080 npm run start:http
# Change the host binding (default is 0.0.0.0)
HOST=127.0.0.1 npm run start:http🛠️ 添加自定义工具和资源
向FastMCP服务器添加自定义工具、资源或提示时：
工具
server.addTool({
name: "hello_world",
description: "A simple hello world tool",
parameters: z.object({
name: z.string().describe("Name to greet")
}),
execute: async (params) => {
return `Hello, ${params.name}!`;
}
});资源
server.addResourceTemplate({
uriTemplate: "example://{id}",
name: "Example Resource",
mimeType: "text/plain",
arguments: [
{
name: "id",
description: "Resource ID",
required: true,
},
],
async load({ id }) {
return {
text: `This is an example resource with ID: ${id}`
};
}
});鼓励
server.addPrompt({
name: "greeting",
description: "A simple greeting prompt",
arguments: [
{
name: "name",
description: "Name to greet",
required: true,
},
],
load: async ({ name }) => {
return `Hello, ${name}! How can I help you today?`;
}
});📚 文档
有关FastMCP的更多信息，请访问 .
有关模型上下文协议的更多信息，请访问 MCP文件.
📄 许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。