Cursor结合MCP实现自动编写项目文档

背景

DeepWiki使用AI驱动,实现对github仓库代码的归纳总结并生成了相应的项目文档。以 transformers 为例,生成的项目文档如下图

作为开发来说,编写一份优质项目文档往往比编写代码本身更耗神,如果是编写一些开源库的教程文档那更是让人头秃。因此,如何利用AI代替人来完成这些较为技术难度较低但是需要准确语言描述的文档生成任务就成了一个很合理的需求。

制定方案

这次我想先针对我本地的项目来生成文档,因此需要依赖MCP调用一些本地文件操作的工具。文档中肯定要一些流程图,让读者可以清晰了解整个项目的流程,所以还可以引入mermaid工具。最后,使用Cursor结合这些工具,根据我们的Prompt来实现这个需求。

同时,我也问了一下AI应该如何实现这个需求,结果如图

结合自己的想法和AI的答案,感觉上面的方案应该是合理的,那就动手试试

实现

配置好相应的MCP工具,相关的工具可以自己去网上找找,只要有对应的功能即可。

然后在Cursor的Agent模式中输入类似下面的Prompt

你需要阅读这个项目所有源码,将整体逻辑以mermaid流程图形式给出,以markdown格式写出一份项目介绍文档,最后把介绍文档写入intro.md

很快,intro.md这个项目介绍文档就生成了,我们打开来看看具体效果

生成的流程图如下

对于项目内容和逻辑大致是对的,对于场景的错误可能是因为把Piping当成管道来理解了,这个后期改改也简单。同时也说明了项目、变量取名或者注释的时候尽量要清晰,避免二义性、表达不清等,才能让AI更好地完成文档生成。

思考

AI代替人类来完成这些技术难度较低的任务需求必然是未来的趋势,人类应该把更多精力放在那些靠机器无法单独实现的任务上。而针对文档生成任务这个需求本身,本文只是给出一个最简单实现方案以及demo。如果需要定制一些文档格式、内容要求或者是需要文档中能给出各个api调用的案例,这不仅需要对Prompt进行更加精细的调试,同时还需要编写代码注释的时候尽量准确、全面。相信不久之后,每个开发者都可以方便地使用AI实现文档自动生成。

相关推荐
掘金安东尼7 分钟前
Google+禁用“一次性抓取100条搜索结果”,SEO迎来变革?
人工智能
FIN666813 分钟前
射频技术领域的领航者,昂瑞微IPO即将上会审议
前端·人工智能·前端框架·信息与通信
小麦矩阵系统永久免费24 分钟前
短视频矩阵系统哪个好用?2025最新评测与推荐|小麦矩阵系统
大数据·人工智能·矩阵
Mr.Lee jack26 分钟前
【vLLM】源码解读:高性能大语言模型推理引擎的工程设计与实现
人工智能·语言模型·自然语言处理
IT_陈寒33 分钟前
Java性能优化:这5个Spring Boot隐藏技巧让你的应用提速40%
前端·人工智能·后端
MicroTech202542 分钟前
微算法科技(NASDAQ:MLGO)开发延迟和隐私感知卷积神经网络分布式推理,助力可靠人工智能系统技术
人工智能·科技·算法
喜欢吃豆1 小时前
多轮智能对话系统架构方案(可实战):从基础模型到自我优化的对话智能体,数据飞轮的重要性
人工智能·语言模型·自然语言处理·系统架构·大模型·多轮智能对话系统
文火冰糖的硅基工坊1 小时前
[嵌入式系统-83]:算力芯片的类型与主流架构
人工智能·重构·架构
视觉语言导航3 小时前
ICRA-2025 | 阿德莱德机器人拓扑导航探索!TANGO:具有局部度量控制的拓扑目标可穿越性感知具身导航
人工智能·机器人·具身智能
西猫雷婶7 小时前
CNN卷积计算
人工智能·神经网络·cnn