Add clean-install script and update README

doggybee · doggybee · commit b5e9e8c779c6 · 2025-04-02T18:38:08.000+08:00
diff --git a/README.md b/README.md
@@ -1,3 +1,82 @@
 # LeetCode MCP Server
 
-A Model Context Protocol (MCP) server for LeetCode that provides access to problems, user data, and contest information through GraphQL.
+&#19968;&#20010;&#22522;&#20110;Model Context Protocol (MCP)&#30340;LeetCode&#26381;&#21153;&#22120;&#65292;&#20351;&#29992;GraphQL&#26597;&#35810;&#19982;LeetCode API&#20132;&#20114;&#12290;
+
+## &#21151;&#33021;&#29305;&#28857;
+
+- &#25903;&#25345;&#26597;&#35810;LeetCode&#38382;&#39064;&#12289;&#29992;&#25143;&#20449;&#24687;&#21644;&#31454;&#36187;&#25968;&#25454;
+- &#36890;&#36807;MCP&#24037;&#20855;&#21644;&#36164;&#28304;&#25552;&#20379;&#32467;&#26500;&#21270;&#35775;&#38382;
+- &#23436;&#25972;&#30340;&#38169;&#35823;&#22788;&#29702;
+- &#27169;&#22359;&#21270;&#26550;&#26500;
+
+## &#20027;&#35201;&#24037;&#20855;
+
+### &#38382;&#39064;&#30456;&#20851;&#24037;&#20855;
+- `get-daily-challenge`: &#33719;&#21462;&#27599;&#26085;&#25361;&#25112;
+- `get-problem`: &#26681;&#25454;slug&#33719;&#21462;&#38382;&#39064;&#35814;&#24773;
+- `search-problems`: &#25628;&#32034;&#28385;&#36275;&#26465;&#20214;&#30340;&#38382;&#39064;
+
+### &#29992;&#25143;&#30456;&#20851;&#24037;&#20855;
+- `get-user-profile`: &#33719;&#21462;&#29992;&#25143;&#36164;&#26009;
+- `get-user-submissions`: &#33719;&#21462;&#29992;&#25143;&#25552;&#20132;&#35760;&#24405;
+- `get-user-contest-ranking`: &#33719;&#21462;&#29992;&#25143;&#31454;&#36187;&#25490;&#21517;
+
+### &#31454;&#36187;&#30456;&#20851;&#24037;&#20855;
+- `get-contest-details`: &#33719;&#21462;&#31454;&#36187;&#35814;&#24773;
+
+## &#36164;&#28304;
+
+### &#38382;&#39064;&#36164;&#28304;
+- `leetcode://daily-challenge`: &#27599;&#26085;&#25361;&#25112;
+- `leetcode://problem/{titleSlug}`: &#38382;&#39064;&#35814;&#24773;
+- `leetcode://problems{?tags,difficulty,limit,skip}`: &#38382;&#39064;&#21015;&#34920;
+
+### &#29992;&#25143;&#36164;&#28304;
+- `leetcode://user/{username}/profile`: &#29992;&#25143;&#36164;&#26009;
+- `leetcode://user/{username}/submissions{?limit}`: &#29992;&#25143;&#25552;&#20132;
+- `leetcode://user/{username}/contest-ranking`: &#29992;&#25143;&#31454;&#36187;&#25490;&#21517;
+
+## &#24555;&#36895;&#24320;&#22987;
+
+### &#23433;&#35013;&#20381;&#36182;
+```bash
+npm install
+```
+
+### &#26500;&#24314;&#39033;&#30446;
+```bash
+npm run build
+```
+
+### &#36816;&#34892;&#26381;&#21153;&#22120;
+```bash
+npm start
+```
+
+### &#24320;&#21457;&#27169;&#24335;
+```bash
+npm run dev
+```
+
+## &#20351;&#29992;&#35828;&#26126;
+
+&#20351;&#29992;Claude for Desktop&#25110;&#20854;&#20182;MCP&#20860;&#23481;&#30340;&#23458;&#25143;&#31471;&#36830;&#25509;&#21040;&#27492;&#26381;&#21153;&#22120;&#12290;
+
+### &#37197;&#32622;&#31034;&#20363;&#65288;Claude for Desktop&#65289;
+
+&#22312;Claude for Desktop&#30340;`claude_desktop_config.json`&#25991;&#20214;&#20013;&#28155;&#21152;&#65306;
+
+```json
+{
+  "mcpServers": {
+    "leetcode": {
+      "command": "node",
+      "args": ["/path/to/leetcode-mcp-server/dist/index.js"]
+    }
+  }
+}
+```
+
+## &#21442;&#32771;
+- &#36825;&#20010;&#39033;&#30446;&#21463;&#21040;[alfa-leetcode-api](https://github.com/alfaarghya/alfa-leetcode-api)&#30340;&#21551;&#21457;
+- &#20351;&#29992;[Model Context Protocol](https://modelcontextprotocol.io)&#35268;&#33539;&#23454;&#29616;
diff --git a/clean-install.sh b/clean-install.sh
@@ -0,0 +1,15 @@
+#!/bin/bash
+
+# &#21024;&#38500;node_modules&#21644;package-lock.json
+echo "&#27491;&#22312;&#28165;&#29702;&#26087;&#20381;&#36182;..."
+rm -rf node_modules package-lock.json
+
+# &#28165;&#29702;npm&#32531;&#23384;
+echo "&#28165;&#29702;npm&#32531;&#23384;..."
+npm cache clean --force
+
+# &#37325;&#26032;&#23433;&#35013;&#20381;&#36182;
+echo "&#37325;&#26032;&#23433;&#35013;&#20381;&#36182;..."
+npm install
+
+echo "&#20381;&#36182;&#23433;&#35013;&#23436;&#25104;&#65281;"

-Original file line number
+Diff line change
@@ @@ -1,3 +1,82 @@ @@
 # LeetCode MCP Server
 -A Model Context Protocol (MCP) server for LeetCode that provides access to problems, user data, and contest information through GraphQL.
 +一个基于Model Context Protocol (MCP)的LeetCode服务器，使用GraphQL查询与LeetCode API交互。
++
 +## 功能特点
++
 +- 支持查询LeetCode问题、用户信息和竞赛数据
 +- 通过MCP工具和资源提供结构化访问
 +- 完整的错误处理
 +- 模块化架构
++
 +## 主要工具
++
 +### 问题相关工具
 +- `get-daily-challenge`: 获取每日挑战
 +- `get-problem`: 根据slug获取问题详情
 +- `search-problems`: 搜索满足条件的问题
++
 +### 用户相关工具
 +- `get-user-profile`: 获取用户资料
 +- `get-user-submissions`: 获取用户提交记录
 +- `get-user-contest-ranking`: 获取用户竞赛排名
++
 +### 竞赛相关工具
 +- `get-contest-details`: 获取竞赛详情
++
 +## 资源
++
 +### 问题资源
 +- `leetcode://daily-challenge`: 每日挑战
 +- `leetcode://problem/{titleSlug}`: 问题详情
 +- `leetcode://problems{?tags,difficulty,limit,skip}`: 问题列表
++
 +### 用户资源
 +- `leetcode://user/{username}/profile`: 用户资料
 +- `leetcode://user/{username}/submissions{?limit}`: 用户提交
 +- `leetcode://user/{username}/contest-ranking`: 用户竞赛排名
++
 +## 快速开始
++
 +### 安装依赖
 +```bash
 +npm install
 +```
++
 +### 构建项目
 +```bash
 +npm run build
 +```
++
 +### 运行服务器
 +```bash
 +npm start
 +```
++
 +### 开发模式
 +```bash
 +npm run dev
 +```
++
 +## 使用说明
++
 +使用Claude for Desktop或其他MCP兼容的客户端连接到此服务器。
++
 +### 配置示例（Claude for Desktop）
++
 +在Claude for Desktop的`claude_desktop_config.json`文件中添加：
++
 +```json
 +{
 +  "mcpServers": {
 +    "leetcode": {
 +      "command": "node",
 +      "args": ["/path/to/leetcode-mcp-server/dist/index.js"]
 +    }
 +  }
 +}
 +```
++
 +## 参考
 +- 这个项目受到[alfa-leetcode-api](https://github.com/alfaarghya/alfa-leetcode-api)的启发
 +- 使用[Model Context Protocol](https://modelcontextprotocol.io)规范实现
-Original file line number
+Diff line change
@@ @@ -0,0 +1,15 @@ @@
 +#!/bin/bash
++
 +# 删除node_modules和package-lock.json
 +echo "正在清理旧依赖..."
 +rm -rf node_modules package-lock.json
++
 +# 清理npm缓存
 +echo "清理npm缓存..."
 +npm cache clean --force
++
 +# 重新安装依赖
 +echo "重新安装依赖..."
 +npm install
++
 +echo "依赖安装完成！"