nano-claw

使用说明（Markdown格式）

• 项目简介

  • nano-claw 是一个以 MCP 为核心的本地后端服务器，提供对资源的托管与访问、工具的注册与执行，以及 Prompt 模板的定义与渲染，旨在为大模型客户端提供稳定、可扩展的上下文服务。

• 主要功能点

  • 资源管理：对代码、文档、数据等资源进行统一访问与管理，便于 LLM 调用。
  • 工具注册与执行：注册内置工具与 MCP 提供的外部工具，允许 LLM 通过统一接口触发外部功能。
  • Prompt 模板与渲染：定义并渲染用于引导与对话的模板，支持可定制的交互模式。
  • MCP 集成：支持通过 MCP 服务注册、查询与调用外部工具，提供多服务器协同能力。
  • 会话与日志：管理会话、运行计划、子代理等，并记录结构化日志，便于回放与审计。
  • 多传输协议与 UI：支持本地 HTTP/WS 等传输，附带简易浏览界面用于调试与监控。

• 安装步骤

  • 准备虚拟环境
    • python -m venv .venv
    • source .venv/bin/activate
  • 安装依赖
    • pip install -r requirements.txt
  • 运行入口
    • python -m src.main
    • 或按 README 提示启动 serve 模式以暴露本地 UI
  • 配置与环境
    • 通过 config.yaml、.env 设置主要参数，环境变量优先级高于配置文件，便于快速覆盖默认行为。

• 服务器配置（MCP 客户端连接用的启动信息，示例以描述性文本给出，实际客户端不需要以下代码）

  • 说明：MCP 客户端需要提供一个包含服务器名称、启动命令与参数的 JSON 配置，以便与 MCP 服务器建立连接与交互。以下为示意性说明文本，实际使用请按客户端需求填充。
  • server name: nano-claw-mcp
  • command: python
  • args: ["-m", "src.server.app", "serve", "--config", "config.yaml"]
  • 备注：该信息用于 MCP 客户端在启动时定位并连接 MCP 服务器；MCP 客户端本身不需要实现服务器端逻辑，仅需要知道如何启动和连接到 MCP 服务器。

• 基本使用方法

  • 启动后，客户端通过 MCP 协议（JSON-RPC）与服务器交互，获取资源、执行工具、获取提示等上下文信息。
  • 通过内置或 MCP 提供的工具进行仓库/环境的任务化操作，支持会话化、日志化和多任务并发。
  • 使用 HTTP/WS/SSE 等传输方式可实现本地 UI 的远程访问与监控。

• 注意事项

  • 如需在生产环境使用，请关注权限、鉴权与会话隔离策略，确保对外暴露接口的安全性。
  • MCP 服务器的配置与扩展应遵循仓库中的约定，确保工具注册、资源渲染及提示模板的兼容性。