# dubbo-api-mcp

**Repository Path**: nele/dubbo-api-mcp

## Basic Information

- **Project Name**: dubbo-api-mcp
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-13
- **Last Updated**: 2025-06-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Dubbo API MCP Server

基于 MCP (Model Context Protocol) 的 Dubbo 接口分析服务器，通过 stdio 方式提供接口方法信息分析功能。

## 快速开始

### 开发环境

#### 1. 编译项目
```bash
mvn compile
```


### 生产环境（推荐）

#### 1. 构建可执行 JAR
```bash
mvn clean package
```

#### 2. 启动 JAR 版本
```bash
./start-mcp-server-jar.sh
# 或直接运行
java -jar target/dubbo-api-mcp-server.jar
```

#### 3. 创建分发包
```bash
./create-distribution.sh
```

这将创建 `dubbo-api-mcp-1.0-SNAPSHOT.tar.gz` 分发包，包含：
- `dubbo-api-mcp-server.jar` - 可执行 JAR 文件
- `start-mcp-server-jar.sh` - 启动脚本
- `mcp-config-jar.json` - MCP 客户端配置
- `DEPLOYMENT.md` - 部署说明
- `README.md` - 使用说明

### 3. 测试功能
```bash
# 获取工具列表
echo '{"jsonrpc":"2.0","id":1,"method":"tools/list","params":{}}' | ./start-mcp-server.sh

# 分析接口方法
echo '{"jsonrpc":"2.0","id":2,"method":"tools/call","params":{"name":"analyze_dubbo_method","arguments":{"groupId":"com.zhicong.manager","artifactId":"manager-api","version":"1.3.1","interfaceName":"com.zhicong.manager.facade.RightsFacade","methodName":"query"}}}' | ./start-mcp-server.sh
```

## 功能特性
- ✅ stdio 通信方式
- ✅ 分析 Dubbo 接口方法参数和返回值
- ✅ 支持复杂类型递归解析
- ✅ 支持泛型类型解析
- ✅ 支持内部静态类解析
- ✅ 提取字段注释信息
- ✅ 完整的 JSON 格式输出

## 工具参数

| 参数 | 类型 | 必填 | 说明 |
|------|------|------|------|
| groupId | string | ✅ | Maven 组 ID |
| artifactId | string | ✅ | Maven 构件 ID |
| version | string | ✅ | 版本号 |
| interfaceName | string | ✅ | 完整的接口类名 |
| methodName | string | ✅ | 方法名称 |

## 前置条件

1. Java 17+
2. Maven
3. Maven 本地仓库中存在对应的源码 JAR 文件

## 文档

详细使用说明请参考 [MCP_USAGE.md](MCP_USAGE.md)

## 作者