Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
C
cursor-usage-example
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
岳建彬
cursor-usage-example
Commits
1e2d0046
Commit
1e2d0046
authored
Jun 26, 2025
by
岳建彬
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
完善短信运营商对接示例
parent
25b51fdc
Show whitespace changes
Inline
Side-by-side
Showing
5 changed files
with
409 additions
and
14 deletions
+409
-14
20250626-Spring分析三方文档实现对接新短信服务商.md
cases/backend/20250626-Spring分析三方文档实现对接新短信服务商.md
+197
-0
README.md
cases/backend/README.md
+20
-0
分析三方文档实现对接新短信服务商.md
cases/backend/分析三方文档实现对接新短信服务商.md
+1
-8
word-mcp-tool使用.txt
tips/word-mcp-tool使用.txt
+1
-6
word-mcp-tool使用指南.md
tips/word-mcp-tool使用指南.md
+190
-0
No files found.
cases/backend/20250626-Spring分析三方文档实现对接新短信服务商.md
0 → 100644
View file @
1e2d0046
# Spring Boot 分析三方文档实现新短信服务商对接
# Spring Boot 分析三方文档实现新短信服务商对接
> **场景**: 通过 Cursor + MCP 工具读取 Word 接口文档,快速实现新短信服务商的集成
>
> **技术栈**: Spring Boot + MCP 工具 + 短信服务集成
>
> **作者**: wangyu
> **日期**: 2025-06-26
---
## 问题描述
在项目开发中,经常需要更换或新增短信服务商。当收到新的接口文档时,通常面临以下挑战:
-
**文档格式多样**
: 三方接口文档通常是 Word 格式,需要人工阅读理解
-
**代码适配耗时**
: 需要分析现有实现,再手写新的集成代码
-
**测试验证复杂**
: 需要理解接口规范,编写测试用例
-
**签名算法复杂**
: 不同服务商的加密和签名规则各异
## 使用 Cursor + MCP 的解决过程
### 1. 配置 MCP 工具
首先在 Cursor 中配置 Word 文档处理工具:
```
json
{
"word-document-server"
:
{
"command"
:
"C:
\\
Data
\\
word_mcp_server.exe"
}
}
```
### 2. 问题分析 Prompt
```
帮我分析一下桌面的WORD文件夹中SMS开头的文档
```
### 3. 深度分析与代码生成
**第二轮 Prompt**
:
```
现在分析项目中需要更换短信服务商,收到接口文档发现是未对接过的,需要写新的短信实现类。
让cursor读取项目已有的短信发送实现类,并读取三方接口文档,直接实现新的短信发送实现类
```
### 4. MCP 工具的关键作用
-
**自动文档解析**
: 直接读取 Word 文档内容,提取接口规范
-
**智能理解**
: 分析接口的认证方式、参数结构、返回格式
-
**现有代码分析**
: 扫描项目中已有的短信实现,理解设计模式
## 解决方案核心代码
### 基于文档分析生成的配置类扩展
```
java
public
class
SmsNaYun
{
private
String
serviceUrl
;
private
String
userName
;
private
String
password
;
private
String
smsSign
;
// 短信内容签名
// getters and setters...
}
```
### 自动生成的短信发送实现
```
java
@Component
public
class
SmsNaYunSendOperationCpt
implements
IOperation
<
SmsModel
>
{
@Override
public
ServiceResult
<
Boolean
>
process
(
SmsModel
smsModel
)
{
// 1. 从配置获取参数
NoticeConfigurationBase
.
SmsNaYun
naYunConfig
=
noticeConfiguration
.
getSmsNaYun
();
// 2. 计算签名(基于文档中的算法)
long
timestamp
=
System
.
currentTimeMillis
();
String
passwordMd5
=
MD5
.
getInstance
().
getMD5
(
naYunConfig
.
getPassword
());
String
sign
=
MD5
.
getInstance
().
getMD5
(
naYunConfig
.
getUserName
()
+
timestamp
+
passwordMd5
);
// 3. 构建请求体(基于文档中的JSON格式)
Map
<
String
,
Object
>
requestBody
=
new
HashMap
<>();
requestBody
.
put
(
"userName"
,
naYunConfig
.
getUserName
());
requestBody
.
put
(
"timestamp"
,
timestamp
);
requestBody
.
put
(
"sign"
,
sign
);
// 4. 处理短信内容签名
String
content
=
smsModel
.
getContent
();
if
(
naYunConfig
.
getSmsSign
()
!=
null
&&
!
naYunConfig
.
getSmsSign
().
isEmpty
())
{
content
=
naYunConfig
.
getSmsSign
()
+
content
;
}
// 5. 发送请求并处理响应
// ... 完整实现逻辑
}
}
```
### 枚举注册
```
java
public
enum
SmsGateWayEnum
{
// ... 其他网关
NAYUN
(
11
,
"那云短信接口"
,
SmsNaYunSendOperationCpt
.
class
);
}
```
## 效果验证
### 内置测试方法
Cursor 还自动生成了独立的测试方法:
```
java
public
static
void
main
(
String
[]
args
)
{
SmsNaYunSendOperationCpt
sender
=
new
SmsNaYunSendOperationCpt
();
// 手动模拟依赖注入
sender
.
restTemplate
=
new
RestTemplate
();
sender
.
noticeConfiguration
=
createTestConfig
();
// 执行测试
ServiceResult
<
Boolean
>
result
=
sender
.
process
(
createTestSms
());
System
.
out
.
println
(
"测试结果: "
+
JSON
.
toJSONString
(
result
));
}
```
### 配置示例
```
yaml
com
:
zhht
:
notice
:
component
:
sms-gateway
:
11
# 使用新的那云接口
sms-na-yun
:
service-url
:
http://api.nayun.com
user-name
:
your_username
password
:
your_password
sms-sign
:
【您的签名】
```
## 关键优势总结
### MCP + Cursor 的协同优势
| 传统方式 | MCP + Cursor 方式 | 效率提升 |
|---------|------------------|---------|
| 手工阅读 Word 文档 | MCP 自动解析文档内容 |
**5倍**
|
| 手写代码适配 | AI 自动生成完整实现 |
**3倍**
|
| 手工编写测试 | 自动生成测试方法 |
**2倍**
|
| 逐步调试验证 | 一次性完整方案 |
**4倍**
|
### 核心价值
1.
**文档理解自动化**
: MCP 工具直接读取 Word 文档,无需人工转换
2.
**代码生成智能化**
: 基于文档规范自动生成完整实现代码
3.
**架构适配无缝化**
: 自动分析现有代码结构,生成符合项目规范的代码
4.
**测试验证便捷化**
: 自动生成独立测试方法,支持快速验证
### 注意事项
-
确保 MCP 工具正确配置和运行
-
生成的代码需要根据实际项目调整包名和依赖
-
测试时需要配置真实的服务商参数
-
生产环境使用前需要充分测试
---
## 相关资源
-
[
MCP 工具使用指南
](
../../tips/word-mcp-tool使用指南.md
)
- 了解如何配置和使用 MCP 工具
-
[
完整对话记录
](
./original-conversations/cursor_sms_word.md
)
- 查看与 Cursor AI 的完整分析过程
4.
---
## 学习建议
想要深入了解 MCP + Cursor 的完整协作过程?
1.
**查看完整对话**
:
[
原始 Cursor 对话记录
](
./original-conversations/cursor_sms_word.md
)
2.
**学习 MCP 配置**
:
[
MCP 工具使用指南
](
../../tips/word-mcp-tool使用指南.md
)
3.
**实践操作**
: 尝试用类似方法处理其他三方接口文档
通过这个案例,您可以学习到:
-
如何有效使用 MCP 工具增强 Cursor 能力
-
文档驱动的代码生成最佳实践
-
企业级项目中的 AI 辅助开发流程
\ No newline at end of file
cases/backend/README.md
View file @
1e2d0046
...
...
@@ -21,6 +21,24 @@
-
自动生成完整的解决方案代码
-
提供测试验证方案
### 2. Spring Boot 分析三方文档实现新短信服务商对接
**文件**
:
`20250626-Spring分析三方文档实现对接新短信服务商.md`
**场景**
: 通过 Cursor + MCP 工具读取 Word 接口文档,快速实现新短信服务商的集成
**关键技术**
:
-
MCP 工具集成
-
Word 文档自动解析
-
Spring Boot 短信服务扩展
-
动态配置和枚举管理
**使用收益**
:
-
文档理解效率提升 5 倍
-
代码生成效率提升 3 倍
-
自动生成测试验证方案
-
无缝集成现有项目架构
---
## 添加新案例
...
...
@@ -38,6 +56,8 @@
## 技术栈覆盖
-
[
x
]
Spring Boot + MQTT
-
[
x
]
Spring Boot + 短信服务集成
-
[
x
]
MCP 工具 + 文档解析
-
[
]
Spring Cloud 微服务
-
[
]
MyBatis Plus 数据库操作
-
[
]
Redis 缓存集成
...
...
cases/backend/分析三方文档实现对接新短信服务商.md
deleted
100644 → 0
View file @
25b51fdc
项目中需要更换短信服务商,收到接口文档发现是未对接过的,需要写新的短信实现类
++ /dev/null
项目中需要更换短信服务商,收到接口文档发现是未对接过的,需要写新的短信实现类
---
使用需求:
让cursor读取项目已有的短信发送实现类,并读取三方接口文档,直接实现新的短信发送实现类
-
[
word-mcp工具使用
](
../../tips/word-mcp.md
)
-
[
与cursor完整对话记录
](
./original-conversations/cursor-sms-word.md
)
\ No newline at end of file
tips/word-mcp-tool使用.txt
deleted
100644 → 0
View file @
25b51fdc
"word-document-server": {
++ /dev/null
"word-document-server": {
"command": "C:\\Data\\word_mcp_server.exe"
}
添加后可读取word文档,转pdf,写入等。共24项功能添加可见
\ No newline at end of file
tips/word-mcp-tool使用指南.md
0 → 100644
View file @
1e2d0046
# Word MCP 工具使用指南
# Word MCP 工具使用指南
> 通过 MCP (Model Context Protocol) 工具让 Cursor 具备直接读取、分析 Word 文档的能力
---
## 🚀 MCP 工具简介
MCP (Model Context Protocol) 是一种标准协议,允许 AI 助手通过外部工具扩展其能力。Word MCP 工具专门用于处理 Microsoft Word 文档,让 Cursor 能够:
-
直接读取 Word 文档内容
-
分析文档结构和格式
-
提取关键信息
-
进行文档转换和处理
## ⚙️ 在 Cursor 中配置 MCP 工具
### 1. 配置方法
在 Cursor 的配置文件中添加以下配置:
```
json
{
"word-document-server"
:
{
"command"
:
"C:
\\
Data
\\
word_mcp_server.exe"
}
}
```
### 2. 配置位置
-
**Windows**
:
`%APPDATA%\Cursor\User\globalStorage\cursor.mcp\config.json`
-
**macOS**
:
`~/Library/Application Support/Cursor/User/globalStorage/cursor.mcp/config.json`
-
**Linux**
:
`~/.config/Cursor/User/globalStorage/cursor.mcp/config.json`
### 3. 验证配置
配置完成后,重启 Cursor,在聊天中可以直接使用类似指令:
```
帮我分析桌面的 WORD 文件夹中的文档
```
## 📋 MCP 工具核心功能
### 文档读取功能
| 功能 | 描述 | 使用场景 |
|------|------|----------|
|
**文档内容提取**
| 读取 Word 文档的纯文本内容 | 分析技术文档、接口规范 |
|
**结构化解析**
| 识别标题、段落、列表等结构 | 理解文档层次和逻辑 |
|
**表格数据提取**
| 提取表格中的结构化数据 | 处理配置表、参数说明 |
|
**图片信息识别**
| 识别文档中的图片和图表 | 理解流程图、架构图 |
### 文档转换功能
| 功能 | 描述 | 使用场景 |
|------|------|----------|
|
**Word 转 PDF**
| 将 Word 文档转换为 PDF 格式 | 文档归档、分享 |
|
**Word 转 Markdown**
| 提取内容并转换为 Markdown | 技术文档迁移 |
|
**格式标准化**
| 统一文档格式和样式 | 文档规范化处理 |
|
**内容重组**
| 按需重新组织文档内容 | 文档整理、摘要生成 |
### 文档分析功能
| 功能 | 描述 | 使用场景 |
|------|------|----------|
|
**关键信息提取**
| 自动识别关键概念和数据 | 快速理解文档要点 |
|
**结构分析**
| 分析文档的组织结构 | 文档质量评估 |
|
**内容分类**
| 将内容按类型进行分类 | 多文档整理 |
|
**差异对比**
| 比较多个文档的差异 | 版本管理、变更跟踪 |
### 数据处理功能
| 功能 | 描述 | 使用场景 |
|------|------|----------|
|
**数据验证**
| 验证文档中数据的准确性 | 质量控制 |
|
**格式统一**
| 统一数据格式和标准 | 数据规范化 |
|
**批量处理**
| 同时处理多个文档 | 大量文档处理 |
|
**模板应用**
| 按模板格式化文档 | 文档标准化 |
## 💡 实际应用场景
### 1. 技术文档分析
**场景**
: 分析三方接口文档,快速理解 API 规范
**Prompt 示例**
:
```
帮我分析这个接口文档,提取以下信息:
1. 接口地址和认证方式
2. 请求参数结构
3. 响应格式说明
4. 错误码定义
```
**价值**
:
-
自动提取关键技术信息
-
避免手工阅读的遗漏
-
快速生成技术摘要
### 2. 需求文档处理
**场景**
: 处理产品需求文档,生成开发任务
**Prompt 示例**
:
```
读取这份需求文档,帮我:
1. 提取功能点清单
2. 识别技术难点
3. 估算开发工作量
4. 生成开发计划
```
**价值**
:
-
结构化需求分析
-
自动生成开发计划
-
减少需求理解偏差
### 3. 代码生成辅助
**场景**
: 基于文档规范生成代码实现
**成功案例**
:
[
Spring Boot 短信服务商对接
](
../cases/backend/20250626-Spring分析三方文档实现对接新短信服务商.md
)
**价值**
:
-
文档驱动的代码生成
-
减少人工编码错误
-
提高开发效率 3-5 倍
## 🔧 最佳实践
### 1. 文档准备
-
**文档格式**
: 确保 Word 文档格式规范,避免复杂的自定义格式
-
**内容结构**
: 使用标准的标题层次结构
-
**图表处理**
: 重要信息不要仅放在图片中,配备文字说明
### 2. Prompt 设计
-
**明确目标**
: 清楚说明要提取什么信息
-
**分步骤**
: 将复杂任务分解为多个步骤
-
**提供上下文**
: 说明文档的业务背景和用途
### 3. 结果验证
-
**交叉验证**
: 对关键信息进行人工验证
-
**测试验证**
: 生成的代码要经过完整测试
-
**迭代优化**
: 根据结果调整 Prompt 和流程
## ⚡ 效率对比
| 传统方式 | MCP + Cursor 方式 | 效率提升 |
|---------|------------------|---------|
| 手工阅读 30 分钟 | MCP 自动解析 3 分钟 |
**10 倍**
|
| 手工整理 20 分钟 | AI 自动摘要 2 分钟 |
**10 倍**
|
| 代码编写 2 小时 | AI 生成 + 调试 30 分钟 |
**4 倍**
|
| 测试验证 1 小时 | 自动生成测试 15 分钟 |
**4 倍**
|
## ⚠️ 注意事项
### 1. 环境要求
-
确保 MCP 工具正确安装和配置
-
验证文件路径和权限设置
-
定期更新 MCP 工具版本
### 2. 使用限制
-
复杂图表可能解析不准确
-
非标准格式文档可能有兼容性问题
-
大文档处理可能需要更多时间
### 3. 安全考虑
-
敏感文档使用时注意数据安全
-
生成的代码需要安全审查
-
遵循公司的 AI 工具使用规范
## 相关资源
-
[
MCP 官方文档
](
https://modelcontextprotocol.io/
)
-
[
Cursor MCP 集成指南
](
https://docs.cursor.com/mcp
)
## 总结
MCP 工具极大地扩展了 Cursor 的能力边界,特别是在处理企业级文档和技术规范方面。通过合理配置和使用,可以显著提升开发效率,减少重复性工作。
\ No newline at end of file
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment