# sky-mcp-server-qq

**Repository Path**: sky365/sky-mcp-server-qq

## Basic Information

- **Project Name**: sky-mcp-server-qq
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-07-14
- **Last Updated**: 2025-07-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# Sky-MCP-Server-QQ

该项目主要用于通过 QQ 号获取相关 QQ 信息的集成服务，基于 Spring Boot 框架开发，适用于 Minecraft 服务器与其他 QQ 集成需求场景。

## 功能简介

- 提供接口通过 QQ 号查询对应的 QQ 信息。
- 集成了 `RestTemplate` 用于处理 HTTP 请求。
- 支持与 QQ API 的交互，通过配置 API Key 实现身份验证。

## 技术栈

- Java 8+
- Spring Boot
- Maven
- RestTemplate

## 项目结构

- `SkyMcpServerQqApplication.java`: Spring Boot 主启动类。
- `config/RestTemplateConfig.java`: 配置类，用于初始化 `RestTemplate`。
- `tools/QQTool.java`: 核心工具类，封装了通过 QQ 号获取信息的功能。
- `application.yml`: 配置文件，包含 QQ API 的相关配置（如 API Key）。

## 快速开始

### 环境准备

- Java 8 或更高版本
- Maven 3.x
- Git（可选）

### 构建与运行

1. 克隆项目：
   ```bash
   git clone https://gitee.com/sky365/sky-mcp-server-qq.git
   cd sky-mcp-server-qq
   ```

2. 安装依赖：
   ```bash
   mvn install
   ```

3. 启动项目：
   ```bash
   mvn spring-boot:run
   ```

## 使用说明

### 获取 QQ 信息

通过 `QQTool` 类的 `getQQInfo` 方法，可以传入 QQ 号查询相关信息。该方法内部使用 `RestTemplate` 发送请求，并依赖 `application.yml` 中的配置。

示例代码：
```java
String qqInfo = qqTool.getQQInfo("123456789");
System.out.println(qqInfo);
```

## 配置信息

在 `application.yml` 文件中，确保配置了正确的 `qq.api-key` 信息：
```yaml
qq:
  api-key: your_api_key_here
```

## 测试

项目包含基础的 Spring Boot 测试类 `SkyMcpServerQqApplicationTests.java`，用于验证 Spring 上下文是否正常加载。

运行测试：
```bash
mvn test
```

## 贡献指南

欢迎贡献代码！如果您希望提交改进或修复，请遵循以下步骤：

1. Fork 本项目。
2. 创建新分支（`git checkout -b feature/your-feature-name`）。
3. 提交更改（`git commit -am 'Add some feature'`）。
4. 推送分支（`git push origin feature/your-feature-name`）。
5. 提交 Pull Request。

## 许可证

本项目遵循 [MIT License](https://opensource.org/licenses/MIT)，详细信息请参考项目根目录下的 LICENSE 文件。