lammps-docs-mcp
v1.0.0
Published
MCP server for LAMMPS documentation knowledge base - provides RAG-based search for LAMMPS commands and usage
Maintainers
erwanjunReadme
LAMMPS-Docs-MCP
一个基于 Model Context Protocol (MCP) 的服务器，为 LAMMPS 分子动力学文档提供 RAG 检索增强搜索。让大语言模型（LLM）能够搜索、查询和引用 LAMMPS 命令、用法模式和最佳实践，帮助你编写、调试和理解 LAMMPS 输入脚本。
功能特性
- 混合搜索 — TF-IDF + 关键词匹配，精准检索文档
- 命令查找 — 精确查找 LAMMPS 命令（如
fix nvt、pair_style lj/cut） - 命令浏览 — 按分类列出所有已索引的命令
- 用法示例 — 获取任意已记录命令的使用示例
- 提示模板 — 内置编写脚本、调试、命令解释、势函数查找等预设提示
- 零依赖 — 纯 JavaScript TF-IDF 实现，无需外部模型或 API 密钥
- 离线运行 — 使用预构建索引，完全本地运行
- 1230 篇文档 — 全面覆盖 LAMMPS 命令、fix、compute、pair style 等
MCP 工具
| 工具 | 描述 |
|------|------|
| search_lammps_docs | TF-IDF + 关键词混合搜索知识库 |
| lookup_command | 按名称查找特定 LAMMPS 命令的文档 |
| list_commands | 列出所有已记录的 LAMMPS 命令，可按分类筛选 |
| get_example | 获取特定命令的使用示例 |
MCP 提示模板
| 模板 | 描述 |
|------|------|
| write_lammps_script | 为给定的模拟任务生成完整的 LAMMPS 输入脚本 |
| explain_command | 获取任意 LAMMPS 命令的详细解释 |
| debug_lammps_script | 分析脚本中的问题，检测常见错误模式 |
| find_potential | 为给定的材料体系找到最佳 pair_style |
安装
方式一：从 npm 安装（推荐）
npm install -g lammps-docs-mcp安装后可直接运行：
lammps-docs-mcp或使用 npx 免安装运行：
npx lammps-docs-mcp提示：中国大陆用户如遇网络问题，可使用淘宝镜像：
npm install -g lammps-docs-mcp --registry=https://registry.npmmirror.com
方式二：从源码构建
git clone https://github.com/erwanjun/LAMMPS-Docs-MCP.git
cd LAMMPS-Docs-MCP
npm install
npm run build客户端配置
Claude Desktop
在 claude_desktop_config.json 中添加：
如果通过 npm 全局安装：
{
"mcpServers": {
"lammps": {
"command": "lammps-docs-mcp"
}
}
}如果从源码构建：
{
"mcpServers": {
"lammps": {
"command": "node",
"args": ["/你的绝对路径/LAMMPS-Docs-MCP/dist/index.js"]
}
}
}配置文件位置：
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json - Linux:
~/.config/Claude/claude_desktop_config.json
VS Code (GitHub Copilot)
在工作区的 .vscode/mcp.json 中添加：
{
"servers": {
"lammps": {
"command": "npx",
"args": ["lammps-docs-mcp"]
}
}
}或从源码构建的方式：
{
"servers": {
"lammps": {
"command": "node",
"args": ["/你的绝对路径/LAMMPS-Docs-MCP/dist/index.js"]
}
}
}Cursor
在 Cursor MCP 设置中添加：
{
"mcpServers": {
"lammps": {
"command": "npx",
"args": ["lammps-docs-mcp"]
}
}
}开发
# 安装依赖
npm install
# 开发模式运行（无需构建）
npm run dev
# 构建 TypeScript
npm run build
# 使用 MCP Inspector 测试
npm run inspect
# 更新知识库后重建 TF-IDF 索引
npm run index
# 完整重建：获取文档 → 处理 → 索引
npm run rebuild-kb知识库
knowledge/ 目录包含 1230 个 Markdown 文件，涵盖 LAMMPS 文档。每个文件都有 YAML 前置元数据：
---
title: "Fix Langevin Thermostat"
description: "fix langevin thermostat including Drude oscillator and eff variants"
category: "fix"
tags: ["thermostat", "langevin", "temperature-control"]
commands: ["fix langevin", "fix langevin/drude", "fix langevin/eff"]
---分类
| 分类 | 描述 |
|------|------|
| general | 简介、安装、错误信息 |
| command | 通用命令（mass、set、dump_modify 等） |
| fix | Fix 命令（恒温器、恒压器、约束等） |
| compute | Compute 命令（能量、RDF、MSD 等） |
| pair_style | 对势（LJ、EAM、ReaxFF、机器学习势等） |
| bond_style | 键势（FENE、harmonic 等） |
| howto | 教程与理论 |
| developer | 代码架构与 API 文档 |
更新知识库
从最新的 LAMMPS 文档刷新：
# 从 LAMMPS GitHub 仓库获取 RST 文档
npm run fetch-docs
# 将 RST 转换为带前置元数据的 Markdown
npm run process-docs
# 重建 TF-IDF 索引
npm run index
# 或一步完成：
npm run rebuild-kb架构
LAMMPS-Docs-MCP/
├── src/
│ ├── index.ts # MCP 服务器入口
│ ├── tools/
│ │ ├── search.ts # TF-IDF + 关键词混合搜索
│ │ └── lookup.ts # 命令查找工具
│ ├── indexer/
│ │ ├── chunker.ts # Markdown → 分块
│ │ ├── embedder.ts # TF-IDF 向量化器
│ │ └── buildIndex.ts # 索引构建脚本
│ └── store/
│ └── vectorStore.ts # TF-IDF 搜索引擎
├── knowledge/ # 1230 篇 LAMMPS 文档（Markdown）
├── data/
│ └── tfidf_index.json # 预构建的 TF-IDF 索引
├── scripts/
│ ├── fetch-lammps-docs.sh # 从 LAMMPS 仓库获取 RST 文档
│ ├── fetch-lammps-docs-api.ts # 备选：通过 GitHub API 获取
│ ├── process-docs.ts # RST → Markdown 转换器
│ └── rst-converter.ts # 自定义 RST 解析器
├── package.json
├── tsconfig.json
└── LICENSE工作原理
- 文档管线：LAMMPS RST 文档 → 带前置元数据的 Markdown → 按标题分块 → TF-IDF 索引
- 搜索：查询被分词后与 TF-IDF 索引匹配（60% 权重）+ 关键词匹配（40% 权重），混合评分
- MCP 协议：服务器通过 Model Context Protocol 以 stdio 方式暴露工具、资源和提示模板
许可证
MIT — 见 LICENSE