S0mbraD/OpenTCM_Discovery

选用指南

AI 根据 README 整理 · 2026/10/20 16:56:52

适用场景

适用于网络药理学、天然产物筛选或准备对接实验时，先查清公开记录。

查看 README 依据

[](https://github.com/S0mbraD/OpenTCM_Discovery/actions/workflows/ci.yml) Pathway search, cross-database checks, and literature-guided docking for TCM small molecules. ## 目录 - [适合谁](#适合谁) - [安装](#安装) - [启动](#启动) - [两种用法](#两种用法) - [七个模块](#七个模块) - [仓库目录](#仓库目录) - [结果怎么读](#结果怎么读) - [数据](#数据) - [自检](#自检) - [引用与许可证](#引用与许可证) ## 适合谁 做网络药理学、天然产物筛选，或准备对接实验时，可以先用它把公开记录查清楚。下表用来选入口。调用之后仍要读返回字段，工具名本身不是结论。 | 你要回答的问题 | 从这里开始 | |---|---| | 这个疾病对应哪些通路和基因？ | `tcm_kegg_disease_pathways`，或 `tcm_smart_run` |

目标用户

面向做网络药理学、天然产物筛选或准备对接实验的研究人员。

查看 README 依据

[](https://github.com/S0mbraD/OpenTCM_Discovery/actions/workflows/ci.yml) Pathway search, cross-database checks, and literature-guided docking for TCM small molecules. ## 目录 - [适合谁](#适合谁) - [安装](#安装) - [启动](#启动) - [两种用法](#两种用法) - [七个模块](#七个模块) - [仓库目录](#仓库目录) - [结果怎么读](#结果怎么读) - [数据](#数据) - [自检](#自检) - [引用与许可证](#引用与许可证) ## 适合谁 做网络药理学、天然产物筛选，或准备对接实验时，可以先用它把公开记录查清楚。下表用来选入口。调用之后仍要读返回字段，工具名本身不是结论。 | 你要回答的问题 | 从这里开始 | |---|---| | 这个疾病对应哪些通路和基因？ | `tcm_kegg_disease_pathways`，或 `tcm_smart_run` |

使用方式

通过MCP服务使用，支持stdio和Streamable HTTP，也可运行本地有向无环图流程。

查看 README 依据

依赖装好之后，可以先跑两条不访问网络的检查。`python scripts/check_repo.py` 核对语法，并核对文档里用反引号写出的工具名是否和代码里注册的 67 个一致。`python -m unittest discover -s tests -q` 核对统计函数、口袋解析和本地整理。这两条通过，只说明仓库里的代码和文档对得上。上游网站通不通，要另跑 `tcm_check_database_status`。 ## 启动 支持 MCP 的客户端都可以接这套服务。配置里的 `<仓库路径>` 换成你的克隆目录。Cursor 的配置文件只是例子之一。同一份模板在 [mcp_server/deployment_config.json](mcp_server/deployment_config.json)。 stdio 由客户端在需要时拉起本地进程： ```json { "mcpServers": { "open-tcm-discovery": { "command": "python", "args": ["<仓库路径>/mcp_server/unified_mcp.py", "--stdio"], "env": { "PYTHONUTF8": "1" } } } } ```

需要常驻服务时用 Streamable HTTP。进程只监听本机，默认端口是 **8002**： ```bash python mcp_server/unified_mcp.py --port 8002 ``` 客户端地址是 `http://127.0.0.1:8002/mcp`。80 个工具都在 `unified_mcp.py`。 只运行 `open_tcm_discovery_mcp.py` 时，进程里只有检索一族，HTTP 默认端口是 8000，不是上面这个 8002。对接族若单独运行 `structure_docking_mcp.py`，默认端口是 8001。本地看板默认是 8765。这几个进程使用不同的端口。推荐用 stdio。它不占端口，客户端在需要时拉起子进程，用完就退出。 确认工具已经注册： ```bash python examples/basic_usage.py ```

pocket -->|否| pause[暂停并写出续跑参数] ``` ### 本地有向无环图 这条路径读取你自己的 Excel 和 CTD 文件，做加权评分，并打开本地看板。 ```bash copy workflow_engine\config.example.yaml workflow_engine\config.yaml python workflow_engine/run_server.py ``` 看板默认地址是 `http://127.0.0.1:8765/`。`config.yaml` 含本机数据路径，不要提交。步骤、阈值和断点续跑见 [docs/WORKFLOWS.md](docs/WORKFLOWS.md)。 看板打不开时，先看 `config.yaml` 里的 `server.port`，默认 8765，再看配置里的数据文件是否存在。MCP 没有启动时，看板不会自己起来。看板没开时，`tcm_smart_run` 也不会因此失败。两边的数字不要写进同一句结论。 MCP 检索和本地加权分是两套结果，引用时分开写。前者写数据库来源和查询时间。后者写输入表和权重。 ## 七个模块 | 模块 | 负责的事 | 说明 | |---|---|---|

部署要求

需要Python 3.10或更高版本，对接需要AutoDock Vina 1.2.5和Meeko。

查看 README 依据

| 手里有一张靶点表，要按行分开已记录和预测？ | `tcm_read_target_table` | | 一张方剂要按一个口径换成克并合计？ | `tcm_formula_weight` | | 对接复现前先检查文献标识和口袋残基？ | `tcm_check_docking_replay` | 工具分工见 [docs/TOOLS.md](docs/TOOLS.md)。 ## 安装 需要 Python 3.10 或更高版本。 ```bash python -m pip install -r requirements.txt ``` 在 Windows 上先执行下面这行，避免中文输出乱码。 ```powershell $env:PYTHONUTF8 = "1" ``` 对接需要 AutoDock Vina 1.2.5 和 Meeko。可执行文件不放进 Git。放法见 [bin/README.md](bin/README.md)。没装 Vina 时，检索、网络、文献和临床试验工具仍可使用。 本地有向无环图还要安装 pandas 和 PyYAML： ```bash python -m pip install -r requirements-workflow.txt ```

已知限制

只做文献写明结合口袋的对接，不做全蛋白盲对接；结果用于提出假设，不是疗效结论。

查看 README 依据

examples/ 最小客户端和调用样例 ``` 文档索引见 [docs/README.md](docs/README.md)。 ## 结果怎么读 这些计算用来提出下一步可以检验的假设。 - 每条在线结果带 `source` 和 `queried_at`。上游报错就返回报错，不另编一条记录。 - 实验记录、结构模板和计算预测分开写。 - 对接输出写成 proposed docking model。只在计算里出现的残基标 `*`，接触画虚线。 - 口袋残基来自文献。没有口袋就不对接，也不做全蛋白盲对接。 - 多个库同时收录，只表示这些库都有该实体。已知相互作用和预测靶点分开计数。 - 文献共现是命中篇数。临床试验匹配是登记信息。二者用来找下一步要读的论文和要做的实验。 - 口服生物利用度不低于 30、类药性不低于 0.18，才按 TCMSP 口径写入「活性成分」。RDKit 的 Lipinski 和 QED 另写。 - `tcm_align_tcmsp` 只对齐调用方已经给出的成分名和 InChIKey。名称相同不是结构相同，也不是靶点或疗效。 - `tcm_read_target_table` 只读调用方给出的靶点表。预测行不并进已记录计数，也不是疗效。