使用说明
mcp指南
通过模型上下文协议为AI代理提供结构化内容交付
mcp-guide是一个mcp服务器,为AI代理提供对项目指南、文档和上下文的有组织访问。它帮助代理了解项目的标准,遵循开发工作流程,并通过灵活的内容管理系统访问相关信息。
主要特点
- 内容管理 -按类别和收藏整理文件、说明和提示
- 模板支撑 -使用Mustache/Chevron模板的动态内容
- 多个传输 -STDIO、HTTP和HTTPS模式
- 功能标志 -项目特定和全局配置
- 工作流管理 -结构化开发阶段跟踪
- 配置文件系统 -常见场景的预配置设置
- Docker支持 -使用SSL进行容器化部署
- OpenSpec集成 -规范驱动的开发工作流程
快速开始
mcp指南是使用AI代理的mcp配置运行的,通常不会直接运行,至少在stdio传输模式下是这样。 在stdio模式下,标准输入和输出用于与MCP通信,因此代理需要按顺序控制两者 操作。 然而,在http模式下,服务器提供web服务器(http)传输,这可以在独立模式下启动,而不是 必须由代理直接执行(尽管通常确实如此)。
下面的配置详细介绍了一些cli代理的配置,但几乎所有这些配置都是相似的。
配置AI代理
JSON配置
这些块可以按原样使用并插入代理的配置中。 stdio模式是一种简单的配置,尽管它需要安装uv工具。
工作室
{
"mcpServers": {
"mcp-guide": {
"command": "uvx",
"args": ["mcp-guide"]
}
}
}
如果“mcpServers”块已存在,请在末尾添加“mcp-guide”块,确保前面的最后一个项目(如果有的话)有一个终止逗号。
Kiro命令行界面
将上述JSON块添加到 ~/.kiro/settings/mcp.json.
克劳德代码
将上述JSON块添加到 ~/.claude/settings.json.
GitHub Copilot命令行界面
将此JSON块添加到 ~/.config/.copilot/mcp.json.
其他客户端将提供类似的配置,有些也
请参阅 安装指南 有关与各种客户端一起使用的更多详细信息,请与docker一起使用并使用http/sse传输模式。
内容组织
mcp指南使用以下方式组织内容 前言 (文档开头的可选YAML元数据)来定义文档属性和行为。
内容通过以下方式分为三类 type: 前沿领域:
- 用户/信息 -向用户显示的内容
- 代理人/信息 -AI代理的上下文
- 代理人/指示 -代理人行为指南
内容组织使用 分类 (文件模式和目录)以及 收藏 (类别组)。集合充当“宏”,为特定任务或目的提供有针对性的上下文。
看 内容管理 了解详情。
功能标志
功能标志控制行为、功能和特殊功能,可以全局设置或按项目设置:
- 工作流 -启用工作流阶段跟踪
- 公开规范 -启用OpenSpec集成
- 内容风格 -输出格式(无、纯、mime)
看 功能标志 了解更多信息。
文档
链接
- 文档: deeprav例如ithub.io/mcp-guide
- 问题: GitHub问题
- MCP协议: 模型上下文协议.io
许可证
MIT许可证-请参阅 许可证.md 了解详情。
