@umengfe/mcp-server-umeng-openapi/README.md

MCP server for using the Umeng OpenAPI

# @umengfe/mcp-server-umeng-openapi

友盟MCP (Model Context Protocol) API的Node.js客户端库，提供了一系列友盟统计数据API的封装。

## 安装

```bash
npm install @umengfe/mcp-server-umeng-openapi
```

## 在cursor中配置
>在cursor的mcp.json文件中添加以下内容： 
```json
{
	"mcpServers": {
		"umeng-openapi": {
			"command": "npx",
			"args": [
        "-y",
        "@umengfe/mcp-server-umeng-openapi"
			],
			"env": {
				"UMENG_API_KEY": "xxx",
				"UMENG_API_SECRET": "xxx"
			}
		}
	}
}
```
> 在window上，需要添加单独的配置
```json
{
  "mcpServers": {
    "umeng-openapi": {
          "command": "cmd",
          "args": [
            "/c",
            "npx",
            "-y",
            "@umengfe/mcp-server-umeng-openapi"
          ],
          "env": {
            "UMENG_API_KEY": "xxx",
            "UMENG_API_SECRET": "xxx"
          }
        }
  }
}
```

## 友盟OpenAPI签名辅助工具
> 该库提供了一个签名辅助工具，输入API密钥和API安全密钥，填写函数和参数，生成签名后的请求URL。

```typescript
import UmengOpenAPI from '@umengfe/mcp-server-umeng-openapi/dist/src/umopenapi.js';
const client = new UmengOpenAPI('your_api_key','your_api_security');
const signedUrl = client.generateSignedUrl('param2/1/com.umeng.uapp/umeng.uapp.getAllAppData', {a:1,b:2});
fetch(signedUrl).then(res => res.json()).then(data => console.log(data));
```

## API文档

### 友盟统计数据

获取所有应用的统计数据。

```typescript

// 返回数据示例（数字仅供参考）
{
  "allAppData": [
    {
      "yesterdayNewUsers": 1234,        // 昨日新增用户
      "yesterdayUniqNewUsers": 1234,    // 昨日独立新增用户
      "todayLaunches": 5000,            // 今日启动次数
      "totalUsers": 100000,             // 总用户数
      "todayNewUsers": 500,             // 今日新增用户
      "yesterdayUniqActiveUsers": 2000,  // 昨日独立活跃用户
      "todayActivityUsers": 1500,        // 今日活跃用户
      "yesterdayLaunches": 4800,         // 昨日启动次数
      "yesterdayActivityUsers": 2100     // 昨日活跃用户
    }
  ]
}
```

## 许可证

MIT

## 更新日志

### [1.0.6] - 2025-05-20
#### 修复
- 修复了参数提取序列化错误的问题

### [1.0.5] - 2025-05-19
#### 新增
- 获取事件参数值时长列表。
- 获取App今天与昨天的统计数据。
- 获取App昨天统计数据。
- 获取App今天统计数据。
- 获取自定义事件的独立用户数。
- 获取渠道维度统计数据。
- 获取版本维度统计数据。
- 获取事件参数值统计数据。
- 获取事件参数值列表。
- 获取自定义事件的统计数据。
- 获取事件参数列表。
- 获取事件列表。
- 获取App新增用户留存率。
- 获取App使用时长。
- 获取App启动次数。
- 获取App活跃用户数。
- 获取App新增用户数。
- 获取App统计数据。
- 创建自定义事件。

### [1.0.4] - 2025-05-12
#### 新增
- 获取单个应用的新增账号。
- 获取单个应用的活跃账号。
- 根据渠道或版本条件，获取App启动次数。
- 根据渠道或版本条件，获取App活跃用户数。
- 根据渠道或版本条件，获取App新增用户数。

### [1.0.3] - 2025-10-06
#### 新增
- 新增获取全部应用数量的能力。
- 新增获取应用列表的能力。

## 常见问题 (FAQ)

- **如何获取 `UMENG_API_KEY` 和 `UMENG_API_SECRET`？**
  请访问友盟开发者平台的[开放API状态页面](https://developer.umeng.com/open-api/state)以获取相关信息。