Skip to content

Latest commit

 

History

History
95 lines (59 loc) · 4.46 KB

README_zh.md

File metadata and controls

95 lines (59 loc) · 4.46 KB

pypreader-mcp

English | 简体中文

Python Version License: MIT

一个读取Python包内容的MCP-Server。该Server允许大语言模型（LLMs）和其他 AI Agents 检查指定环境中 Python 包的内容。

概述

pypreader-mcp 充当 AI 模型和本地Python环境之间的桥梁。通过MCP暴露一组工具，它使 AI 能够以编程方式浏览已安装的包，查看其文件结构，并读取其源代码。这对于代码分析、依赖项检查和自动化编程辅助等任务非常有用。

为什么整这东西？

当我使用集成了 AI 的编程 IDE，如Cursor或Trae时，我总是发现当前使用的模型不知道我需要的第三方库。

但他们有时还会假装自己知道很认真的生成一堆不可名状的东西，另一些时候它们会去互联网搜索时，但基本上结果都是不咋地，很难找到任何有用的信息。

所以我制作了这个 MCP 服务。它可以从官方网站 pypi.org 读取文档，或者读取你 Python 对应的 site-packages 环境中的源代码，以便更直接地了解你想使用的第三方库的内容。

功能

该Server向 MCP 客户端提供以下工具：

  • get_pypi_description(package_name: str)：从 PyPI 获取包的官方描述。
  • get_package_directory(package_name: str)：列出指定已安装包的整个文件和目录结构。
  • get_source_code_by_path(package_path: str)：检索包内特定文件的完整源代码。
  • get_source_code_by_symbol(package_path: str, symbol_name: str)：获取指定符号（函数、类等）的定义（代码段）。

用法

此工具旨在作为一个 MCP Server，在诸如 Cursor 或 Trae 等基于 AI 的环境中使用。

配置

在你的 AI 环境的 MCP Server配置中，添加一个具有以下设置的新Server。这允许 AI 使用 uvx 直接从其 Git 存储库运行服务。

{
  "mcpServers": {
    "PypReader-MCP": {
      "command": "uvx",
      "args": [
        "--from",
        "git+https://github.com/zakahan/pypreader-mcp.git",
        "pypreader-mcp"
      ],
      "env": {
        "CURRENT_PYTHON_PATH": "<your-python-path>",
        "CURRENT_LOGGING_LEVEL": "INFO"
      }
    }
  }
}

MCP-Server参数

在你的 AI 环境中配置 MCP Server时，你可以指定以下env参数：

  • CURRENT_PYTHON_PATH：指定目标包安装环境的 Python 可执行文件的路径。如果未提供，它将默认为运行Server的 Python 可执行文件。你可以通过激活项目的 Python 环境并在终端中运行 which python 来找到正确的路径。
  • CURRENT_LOGGING_LEVEL：设置Server的日志记录级别。选项有 DEBUG、INFO、WARNING、ERROR、CRITICAL。默认值是 INFO。

如果你使用 Python 虚拟环境来配置 Python 项目，通常，你需要随时修改 python_path，以切换到你指定的 Python 环境。

AI 编码示例

以 Trae 为例。目前（2025-07-02），doubao-seed-1.6 模型不知道 fastmcp 包（其实大部分模型也不认识）。在正常情况下，它要么会假装自己知道然后输出一堆乱七八糟、难以描述的错误内容，甚至会觉得我是在说FastAPI，要么就会进行生硬的搜索，找到各种杂乱的信息。

这次，我创建了一个 Trae 智能体，它配备了这个项目的 mcp-server。结果如下，Trae 可以理解我的项目，然后编写 fastmcp 的服务来完成我的任务。

这是 Trae 完成我请求的任务的整个过程

trae_examples

这些是工具调用的具体细节

tools

许可证

本项目采用 MIT 许可证。有关详细信息，请参阅 LICENSE 文件。

What's New Now?

  • 2025-07-06: 重写了get_source_code_by_symbol，以读写临时文件代替stdio，以支持windows平台。
  • 2025-07-04: 重写了get_source_code_by_symbol工具，修复了无法读取子package所属的类或函数的问题。

What's Next?

  1. 解决python-package-name与实际路径不一致的问题，例如google-adk的包名，实际路径却是google/adk，实际import的是google.adk
  2. 设计一个比较合适的prompt，用于Agent。(Trae版本在这里)