Skip to content

mengchengTang/msAgent

 
 

Repository files navigation

🚀 msAgent

msAgent 是一个强大的命令行智能助手,专为开发者和运维人员设计。它不仅具备与大语言模型(LLM)对话的能力,还能通过 Model Context Protocol (MCP) 扩展各种本地工具,例如文件操作、代码分析、系统监控等。

msAgent

✨ 核心特性

  • 多模态交互:支持基于 Textual 的现代化 TUI 界面,同时也提供简洁的命令行交互模式。
  • MCP 扩展支持:原生支持 Model Context Protocol (MCP),可以无缝集成任何符合 MCP 标准的工具(如 Fetch, Filesystem 等)。
  • 多 LLM 支持:灵活切换 OpenAI, Anthropic, Google Gemini 等多种大模型后端。
  • 智能上下文管理:自动根据任务需求调用相应的工具,无需手动介入。
  • 流式响应:实时的打字机效果,让对话更加自然流畅。

📦 快速开始

安装

使用 uv 进行安装(推荐,支持 Python >= 3.11):

# Clone the repository
git clone https://github.com/kali20gakki/msAgent.git
cd msagent

# Install dependencies
uv sync

启动对话

TUI 模式(推荐)

启动现代化的终端用户界面:

uv run msagent chat --tui

命令行模式

启动简单的命令行对话:

uv run msagent chat

⚙️ 配置指南

msAgent 需要配置 LLM 后端才能工作。首次运行会自动创建配置文件。

查看当前配置

uv run msagent config --show

设置 LLM 提供商

# OpenAI
uv run msagent config --llm-provider openai --llm-api-key "your-key" --llm-model "gpt-4"

# Anthropic
uv run msagent config --llm-provider anthropic --llm-api-key "your-key" --llm-model "claude-3-opus-20240229"

# Gemini
uv run msagent config --llm-provider gemini --llm-api-key "your-key" --llm-model "gemini-2.0-flash"

# Custom OpenAI-compatible API (self-hosted gateway / proxy / compatible vendor)
uv run msagent config --llm-provider openai --llm-api-key "your-key" --llm-base-url "http://127.0.0.1:8045/v1" --llm-model "your-model-name"

MCP 服务器管理

# 列出 MCP 服务器
msagent mcp list

# 添加 MCP 服务器
msagent mcp add --name filesystem --command npx --args "-y,@modelcontextprotocol/server-filesystem,/path"

# 移除 MCP 服务器
msagent mcp remove --name filesystem

🧠 Skills(内置技能)

msAgent 启动时会自动加载工程根目录下的 skills/ 目录,并将其中的 skill 提供给 deepagents 使用。

目录结构

每个 skill 必须使用以下结构:

skills/
  <skill-name>/
    SKILL.md

SKILL.md 格式要求

SKILL.md 需要包含 YAML frontmatter,并至少有以下字段:

---
name: your-skill-name
description: 说明这个 skill 做什么,以及在什么场景触发
---

注意:

  • name 需要和 skill 目录名保持一致(例如 skills/code-review/SKILL.mdname 应为 code-review)。
  • description 要写清楚触发条件,便于 agent 正确选择 skill。

新增一个 skill

  1. 在工程根目录创建子目录:skills/<skill-name>/
  2. 新建 skills/<skill-name>/SKILL.md,按上面的格式填写 namedescription
  3. 重新启动 msagent,新 skill 会被自动加载

查看帮助

# 显示帮助信息
msagent --help

# 显示版本
msagent --version

# 显示详细信息
msagent info

🔌 MCP 服务器示例

文件系统服务器

msagent mcp add --name filesystem --command npx --args "-y,@modelcontextprotocol/server-filesystem,/home/user/documents"

SQLite 服务器

msagent mcp add --name sqlite --command npx --args "-y,@modelcontextprotocol/server-sqlite,/path/to/database.db"

自定义 MCP 服务器

msagent mcp add --name myserver --command python --args "/path/to/server.py"

🛠️ 开发

安装开发依赖

uv sync --dev

运行测试

uv run pytest

代码格式化

uv run ruff format .
uv run ruff check .

📝 命令参考

命令 描述
msagent chat [message] 启动聊天会话
msagent ask <question> 单轮问答
msagent config --show 查看配置
msagent mcp list 列出 MCP 服务器
msagent mcp add --name <n> --command <c> 添加 MCP 服务器
msagent mcp remove --name <n> 移除 MCP 服务器
msagent info 显示信息
msagent --version 显示版本

🔗 相关链接

📄 许可证

MIT License

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • Python 100.0%