使用说明（Markdown 格式）

项目简介
- NiceVibes MCP 服务器是一个基于 Model Context Protocol (MCP) 的后端服务，实现了 MCP 的核心能力，包括暴露资源、执行工具、查询主题与示例、获取组件信息及相关文档等，以帮助大语言模型（LLM）在对 NiceGUI 应用进行开发时获取结构化上下文和外部能力。
主要功能点
- 工具相关
  - list_tools：列出可用的 MCP 工具
  - call_tool：按名称和参数调用工具
- 资源相关
  - list_resources：列出可用资源
  - read_resource：按 URI 读取资源内容（如主题索引、主提示等）
- 主题与示例相关
  - list_topics/get_topic：获取 NiceGUI 文档主题及详细内容
  - search_topics：按关键词搜索主题
  - list_samples/get_sample_source：列出示例及获取示例源码
- 组件与文档相关
  - get_component_info：获取 NiceGUI 组件的综合信息（包含文档链接、GitHub 源码链接、继承关系、源码等）
  - get_component_source：获取组件的源码
  - get_component_docs：获取组件官方文档内容
- 其他 MCP 功能
  - get_project_creation_guide、project_setup：引导性项目创建流程及生成项目结构
  - kill_port_8080、open_browser、capture_url_screenshot：辅助调试与视觉验证（可选、按需开启）
- MCP 服务端交互
  - 通过标准的 JSON-RPC 请求/响应结构与客户端交互，支持会话管理和能力声明，所有响应遵循 MCP 的约定。
安装步骤
- 1. 安装依赖
  - 使用 Poetry 或等效工具安装依赖，例如执行：poetry install
- 1. 运行 MCP 服务器
  - 可替代的启动方式有：
    - poetry run python -m nice_vibes.mcp
    - python -m nice_vibes.mcp
  - 启动后服务器会等待来自 MCP 客户端的连接并开始 JSON-RPC 交互。
- 1. MCP 客户端配置（由客户端使用，与本仓库无关的配置示例）
  - MCP 客户端需要配置一个 MCP 服务器连接入口，示例配置如下（JSON，注意以下字段含义）： { "mcpServers": { "nice-vibes": { "command": "/path/to/python", "args": ["-m", "nice_vibes.mcp"] } // 以上为对接 NiceVibes MCP 服务器的最小可行配置 } }
  - 说明：
    - command：用于启动 MCP 服务器进程的可执行程序路径，通常指向 Python 可执行文件。
    - args：启动参数，此处应包含 -m nice_vibes.mcp，表示以 MCP 服务端模块方式运行。
    - 该配置用于 MCP 客户端建立与服务器的连接并发起请求；客户端通常需要此信息，但本 MCP 服务器端并不需要在运行时暴露该配置给自身。
- 1. 基本使用前的准备
  - 确保 NiceGUI 项目相关的资源、工具和文档内容已就绪（仓库中已提供完整的资源、工具、文档与示例逻辑，LLM 客户端可通过 MCP 调用获取）。
  - 如需测试，仓库自带的测试用例可用于本地验证 MCP API 的行为。
服务器使用方法
- 通过 MCP 客户端向服务器端发起 JSON-RPC 请求，例如请求工具列表、读取资源、查询主题、获取源码等。
- 服务器在处理请求后返回符合 MCP 标准的 JSON-RPC 响应，包含结果或错误信息。
- 服务器端还实现会话管理与能力声明，便于多轮对话场景中对上下文与能力的协商。
设计要点
- 全面的资源、工具、主题、示例等能力暴露，兼容常见的 MCP 客户端工作流。
- 对 NiceGUI 的文档、源码、组件信息及示例进行结构化封装，便于 LLM 在推断和执行任务时获取上下文。
- 提供必要的辅助工具（如截图、打开浏览器、端口控制等）以支持可观测的开发与调试流程。
基本使用示例
- 启动 MCP 服务器后，MCP 客户端可以：
  - 调用 list_tools 获取支持的工具清单
  - 调用 read_resource 读取 topics、master prompts 等资源
  - 调用 get_topic/get_topic 与 search_topics 查阅 NiceGUI 文档主题
  - 调用 get_component_info/get_component_source/get_component_docs 获取组件信息与源码
  - 调用 capture_url_screenshot 对运行中的页面进行截图验证
- 如需进行项目创建引导，可调用 get_project_creation_guide 或 project_setup 获取结构化的创建指引
关键词
- LLM 集成, JSON-RPC, NiceGUI 文档, 资源管理, 工具执行
分类
- 6

关键词

信息