使用说明
门挡MCP
快速而肮脏地实施 MCP服务器 对于Python 门挡框架.
| 端口 | 描述 |
|---|---|
| 3001 | DoorstopMCP服务器 |
| 7867 | 门挡服务器的调整版本将在页面重新加载时更新 |
| 62746273002 | 启动Docker时的MCP资源管理器 --profile inspector |
快速入门
[!警告]
此工具尚未准备好用于生产,因为没有用户身份验证。 请仅在受信任的网络中使用MCP服务器。竞争条件也可能是 当多个用户/代理同时使用该工具时,这是可能的。
使用Docker
docker compose up --force-recreate
使用VS代码
# Create the (local) repo where the requirements are tracked
mkdir reqs
cd reqs
git init
# Create all documents you need, e.g.
doorstop create REQ ./reqs/req
doorstop create LLR ./reqs/llr --parent REQ
doorstop create TST ./reqs/tests --parent REQ
然后在运行和调试(Ctrl+Shift+D)窗格中启动 Python调试器:模块 发射目标。
检查结果
容器也将启动 门挡服务器 在一个单独的过程中,这样你就可以直观地检查你的结果。最初,html导出器只是 跑一次,所以我们不得不 叉子 门挡项目和 调整它以在每次重新加载页面时获取文档树。
只需导航到 http://{YOUR_HOSTNAME_IP}:7867 并在每次更改后刷新。
测试API
您可以从命令行使用以下web GUI浏览MCP:
npx -y @modelcontextprotocol/inspector
或者使用MCP Explorer启动第二个容器:
docker compose up --force-recreate --profile inspector
MCP资源管理器的选项:
- 传输类型:流式HTTP
- 网址: 本地主机:3001/mcp
- 连接类型:通过代理
MCP客户端
将提示客户端连接到此MCP服务器的一些示例配置。 此列表并不详尽,请随时使用您使用的客户端打开拉取请求:
打开WebUI配置
在管理界面中创建一个新的外部工具,将类型设置为 MCP Streamable HTTP,
URL指向 http://{YOUR_URL}:3001/mcp 并确保禁用身份验证,因为这还没有实现
由此MCP服务器支持,并将导致Open WebUI默认忽略该工具。
如果您想使此工具可用于
非管理员用户
Vibe CLI配置
要将此MCP服务器与Mistral Vibe CLI一起使用,请在配置中添加以下内容:
[[mcp_servers]]
name = "doorstop"
transport = "streamable-http"
url = "http://localhost:3001/mcp"
反重力MCP配置
{
"mcpServers": {
"doorstop": {
"serverUrl": "http://localhost:3001/mcp"
}
}
}
自定义属性
需求工程中常用的一些属性,如功能/非功能 要求是门挡中的事后想法,必须 手动添加 由框架的用户创建。以下是通过此扩展的属性列表 MCP服务器。它们会自动添加到每个文档中,在创建项目时,它们可以 人口。
| 属性 | 示例 |
|---|---|
type |
功能性、非功能性或约束性 |
review-method |
按设计、测试、检查、分析、演示进行审查 |
如何将它们添加到每个.doorstop.yml文件中的示例:
# [...]
attributes:
reviewed:
- type
- verification-method
html导出的无文档属性
文档中目前还缺少调整某些字段的属性 html导出版本。请参阅以下示例 门挡的要求 项目:
settings:
digits: 3
prefix: REQ
sep: ''
attributes:
defaults:
doc:
name: 'Requirements'
title: 'Requirements for _Doorstop_'
ref: 'REQ-DS-2024'
by: 'Wfg'
major: '1'
minor: 'A'
copyright: 'Doorstop'
实施状态
- [x] 阅读所有文档
- [x] 阅读所有项目
- [x] 阅读门挡框架版本
- []create:创建一个新的文档目录
- []delete:删除文档目录
- [x] 添加:在文档目录中创建项目文件
- []remove:从文档目录中删除项目文件
- []编辑:打开现有项目或文档进行编辑
- []重新排序:组织文档的大纲结构
- []链接:在两个项目之间添加新链接
- []取消链接:删除两个项目之间的链接
- []clear:免除项目的可疑链接状态
- []审查:免除项目的未审查状态
- []
导入:导入现有文档或项目 - []
导出:将文档导出为YAML或其他格式 - [x] 发布:以文本或其他格式发布文档
- []切换工作空间的能力,因此MCP可以处理不同的项目
