Starlight With MCP

MCP文档知识

提供方 microcosem

文档知识 未标注 无需鉴权 社区 / 第三方

使用模型上下文协议(MCP)从多个来源自动生成文档的工具。

一句话选型结论

按资料字段整理

Starlight With MCP 属于文档知识类 MCP 服务器,传输方式未标注,无需鉴权,没有现成安装命令,需按官方文档接入。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类文档知识 传输方式未标注 鉴权无需鉴权 部署方式未标注
GitHub 星标 1 仓库热度,无公开仓库时显示未标注
工具数 10 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

文档知识
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量10暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

适用场景

文档生成JavaScript本地部署自动化多源整合API文档OpenAPI

安装与配置

未标注 无需鉴权
上游未给出传输方式
  1. 1
    准备运行环境

    按官方文档确认运行环境(常见为 Node.js 或 Python),装好后再执行安装命令。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后客户端会列出约 10 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
文档检索问答

在你的文档库里按问题找答案。

知识库读写

把新资料写进知识库,随用随取。

内容整理

把零散资料归纳成结构化笔记。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 资料标注 10 个工具,职责相对集中,接入后不容易误操作。
  • 资料标注无需鉴权,装好就能连。

先想清楚的地方

  • 没有现成安装命令,需要按官方文档自己填启动命令和参数。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在文档知识场景里让模型直接调用外部能力的人。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Starlight With MCP当前 10 未标注 未标注 无 2026-05-17
dify 未标注 stdio · 本地进程 本地部署 有 2026-04-11
open-webui 未标注 stdio · 本地进程 本地部署 有 2026-04-11
JeecgBoot 未标注 stdio · 本地进程 本地部署 有 2026-04-11
Cherry Studio 未标注 未标注 未标注 无 2026-05-17
mempalace 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

文档知识
字段来自项目仓库与公开索引,中文说明由本站标注
提供方microcosem上游标注的维护方 microcosem
分类文档知识本站按上游分类展示
连接方式未标注上游未给出传输方式
鉴权方式无需鉴权远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时未标注 · 未标注本地安装时用到的包标识与运行时
部署类型未标注上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

6.1 KB
来自项目仓库与上游目录的原文,未做删改

星光MCP演示

使用MCP(模型上下文协议)从多个来源生成文档的演示。

🚀 快速启动

1.安装依赖项```bash

npm install
cd mcp-server && npm install && cd ..
cd petstore-mcp-server && npm install && cd ..
cd mcp-client && npm install && cd ..


### 2.测试工作流程```bash
# Test all components
npm run test-workflow

# Run the complete demo
npm run demo

# View the documentation
npm run dev

📋 这个演示显示了什么

该项目演示了从多个来源自动生成文档的完整MCP工作流程。

🏗️ 建筑```

┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
│ Starlight │ │ MCP Client │ │ Pet Store │
│ Docs Site │◄───┤ (Orchestrator) │◄───┤ MCP Server │
│ │ │ │ │ │
│ - Guides │ │ - Connects to │ │ - OpenAPI Spec │
│ - Reference │ │ multiple MCP │ │ - API Endpoints │
│ - API Docs │ │ servers │ │ - Data Schemas │
│ - Generated │ │ - Generates docs │ │ - Examples │
└─────────────────┘ └──────────────────┘ └─────────────────┘


## 🔧 MCP客户端/服务器架构

该项目展示了一个完整的 **模型上下文协议(MCP)** 自动化文档生成的工作流程。它由三个主要部分组成:

### 🎯 **MCP客户端** (`mcp-client/client.js`)

这 **星光MCP客户端** 充当连接到多个MCP服务器并协调文档生成的编排器:

**主要特点:**

- **多服务器连接**:可以同时连接到多个MCP服务器
- **工具执行**:调用远程服务器上的工具并处理响应
- **资源管理**:从连接的服务器读取并列出资源
- **文档生成**:自动从多个来源生成组合文档
- **文件系统集成**:将生成的文档写入星光文档结构

**主要方法:**

- `connectToServer()` -建立与MCP服务器的连接
- `generateApiDocs()` -从宠物商店服务器生成API文档
- `generateStarlightDocs()` -检索现有的星光文档结构
- `generateCombinedDocs()` -结合多个来源创建统一的文档

### 🏪 **宠物店MCP服务器** (`petstore-mcp-server/server.js`)

此服务器提供基于OpenAPI规范的API文档工具:

**可用工具:**

- `get_api_specification` -返回完整的OpenAPI规范
- `list_endpoints` -列出所有API终结点(可按标记筛选)
- `get_endpoint_details` -获取有关特定终结点的详细信息
- `get_schemas` -检索数据模型和模式
- `generate_markdown_docs` -生成格式化的markdown文档
- `get_api_info` -返回基本的API元数据

**关键能力:**

- **OpenAPI集成**:阅读自 `petstore-api.json` 规格
- **灵活的输出**:支持不同的文档格式(完整、端点、模式、概述)
- **示例生成**:包括请求/响应示例
- **资源访问**:提供对原始API规范文件的访问

### 📚 **星光MCP服务器** (`mcp-server/server.js`)

此服务器管理现有的星光文档,并提供内容发现工具:

**可用工具:**

- `list_docs` -列出所有文档页面(可按类别筛选)
- `search_docs` -按关键字搜索文档内容
- `get_doc_content` -使用frontmatter检索特定页面内容
- `get_site_structure` -返回完整的网站导航结构

**关键能力:**

- **内容发现**:扫描 `src/content/docs/` 目录
- **前端处理**:从markdown文件中提取元数据
- **搜索功能**:跨文档的全文搜索
- **结构分析**:提供网站导航和组织
- **资源访问**:列出并读取文档文件

### 🔄 **工作流过程**

典型的工作流程遵循以下模式:

1. **客户端初始化**:MCP客户端启动并准备连接到服务器
1. **服务器连接**:客户端连接到宠物店和星光MCP服务器
1. **内容检索**:
- 宠物商店服务器提供OpenAPI规范中的API文档
- 星光服务器提供现有的文档结构
1. **文档生成**:客户端组合内容并生成统一的文档
1. **文件输出**:生成的文档将写入 `src/content/docs/`
1. **清理**:客户端与所有服务器断开连接

### 🏗️ **架构优势**

- **模块化设计**:每个服务器都有特定的职责
- **可扩展**:易于为不同的内容源添加新的MCP服务器
- **自动化**:文档生成可以集成到CI/CD管道中
- **基于标准的**:使用官方MCP SDK和协议
- **内容感知**:了解API规范和现有文档

## 🧞 可用命令

|命令|操作|
| :------------------------ | :----------------------------------------------- |
| `npm install` |安装依赖项|
| `npm run dev` |在以下位置启动本地开发服务器 `localhost:4321` |
| `npm run build` |构建您的生产站点(包括文档生成)|
| `npm run preview` |在部署之前,在本地预览您的构建|
| `npm run demo` |运行完整的MCP工作流演示|
| `npm run test-workflow` |测试所有MCP组件|
| `npm run generate-docs` |从MCP服务器生成文档|
| `npm run demo-petstore` |仅测试宠物店MCP服务器|
| `npm run demo-starlight` |仅测试星光MCP服务器|

## 📁 项目结构```
.
├── mcp-server/              # Starlight MCP server
├── petstore-mcp-server/     # Pet Store API MCP server
├── mcp-client/              # MCP client orchestrator
├── src/content/docs/        # Generated documentation
├── test-workflow.js         # Workflow test script
└── MCP-DEMO-WORKFLOW.md     # Detailed documentation

🔍 生成的文档

运行演示后,您会发现:

  • API文档: src/content/docs/api/petstore-api.md
  • 更新索引: src/content/docs/index.mdx

📚 了解更多

  • MCP演示工作流程指南 -详细文件
  • 星光文件
  • 模型上下文协议

👀 想了解更多吗?

结账 星光的文档,阅读 Astro文件,或跳进 Astro Discord 服务器.

常见问题

5 问
答案由本站依据条目字段整理,不引用上游原文
Starlight With MCP 怎么安装?

资料没有给出安装命令,请到官方仓库或文档按说明接入;这类条目多数是生态应用,或尚未发布可安装包。

Starlight With MCP 怎么在客户端里配置?

它的传输方式未标注,在客户端 MCP 配置里按官方文档填写启动命令和参数,保存后重启客户端生效。

Starlight With MCP 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Starlight With MCP 需要 API Key 吗?

资料标注为无需认证,装好就能连;如果实际调用时报鉴权错误,按官方文档补上凭据。

Starlight With MCP 能提供哪些能力?

资料显示约 10 个工具;能力标签包括 文档生成、JavaScript、API集成、API文档。具体工具清单以官方文档为准。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。