内容
# @ramoira/mcp
MCP 服务器,将 Ramoira 品牌架构规范以工具和资源的形式公开。
任何兼容 MCP 的客户端(Claude Desktop、Cursor、Windsurf 等)都可以连接到此服务器,并使用它来生成、验证或推理 Ramoira 品牌架构 — 无需安装 CLI。
## 公开内容
### 工具
| 工具 | 描述 |
|---|---|
| `get_spec_overview` | 架构格式的高级解释,及其五层和关键概念。从这里开始。 |
| `get_layer_spec(layer)` | 某一层的完整字段定义:`identity`、`narrative`、`voice`、`commercial` 或 `governance`。 |
| `get_valid_enums()` | 所有约束字段的有效枚举值,附带字段路径。 |
| `get_example_schema()` | 一个高质量的示例(劳力士),展示了填充良好的字段的样子。 |
| `search_spec(query)` | 跨所有规范文档的关键词搜索。 |
### 资源
| URI | 描述 |
|---|---|
| `ramoira://spec` | 作为纯文本资源的规范概述。 |
| `ramoira://enums` | 作为 JSON 资源的有效枚举值。 |
## 它在 Ramoira 中的位置
```
ramoira/brand-schema-spec ← 规范(真实来源)
│
▼
ramoira/mcp ← 此包
将规范作为 MCP 工具公开,供任何 LLM 使用
│
├─► Claude Desktop / Cursor / 任何 MCP 客户端
│ 任何 LLM 会话都可以按需查找规范
│
└─► ramoira/cli(内部)
ramoira init 在本地使用相同的工具集
以在架构生成期间为 Claude 提供规范访问权限
```
CLI 的生成器在本地镜像此工具集(无需网络依赖),因此 `ramoira init` 可以离线工作。此服务器适用于外部 LLM 工作流程 — 任何需要生成或验证架构的代理都可以连接到此处,而不是在提示中内联规范。
## 安装
```bash
npm install -g @ramoira/mcp
```
或在不安装的情况下直接运行:
```bash
npx @ramoira/mcp
```
## 在 Claude Desktop 中配置
添加到 `~/Library/Application Support/Claude/claude_desktop_config.json`(macOS)或 `%APPDATA%\Claude\claude_desktop_config.json`(Windows):
```json
{
"mcpServers": {
"ramoira": {
"command": "npx",
"args": ["@ramoira/mcp"]
}
}
}
```
## 在 Cursor / VS Code 中配置
添加到您的 MCP 设置:
```json
{
"ramoira": {
"command": "npx",
"args": ["@ramoira/mcp"]
}
}
```
## 公共 HTTP 主机
服务器当前使用 stdio 传输协议,适用于本地客户端。要通过 HTTP 公开提供服务,请在 `src/server.ts` 中替换传输协议:
```ts
import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js";
const transport = new StreamableHTTPServerTransport({ port: 3000 });
await server.connect(transport);
```
然后部署到任何 Node.js 主机。客户端通过 MCP HTTP 客户端连接到 `https://mcp.ramoira.com`(或其托管位置)。
## 开发
```bash
npm install
npm run dev # 通过 tsx 运行(无构建步骤)
npm run build # 编译到 dist/
```