makecindy / makecindy/cindy

feat: 提供官方文档/源码检索的 MCP 服务(或 skill),让 agent 直接了解 Cindy,类似 openai-docs

Open
#1,462 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
2.7k
Forks
395
Avg merge
21h 48m
Merged PRs (30d)
776

Description

**客户端版本**: 0.1.27
**反馈类型**: feature

---

## 使用场景 / Use case

用户在使用 Cindy 桌面端时,希望 agent 能像 Codex 使用 openai-docs MCP 一样,直接检索 Cindy 的官方文档与源码,回答「这个功能怎么用」「某模块怎么实现的」。目前安装版不携带源码,agent 只能靠 get_capabilities 的静态能力清单,无法检索源码/架构细节,每次都需要用户手动 clone 仓库或指路。

## 当前局限 / Current limitation

- `get_capabilities` 只是静态能力索引,没有检索/浏览源码的能力
- `about-cindy` 明确说明「安装版不携带源码,agent 无法推断用户是否 clone 过」:要读源码得用户给路径或用工程模式打开,门槛高
- 对比 Codex 的 openai-docs(search/fetch 的 MCP + skill),Cindy 缺一个官方维护、可检索的知识入口

## 建议方案 / Proposed solution

参考 Codex/OpenAI 的三层结构:

1. **MCP 检索服务**:提供 search/fetch 官方文档与源码索引(openai-docs 形态),内容覆盖能力文档 + 关键模块源码路径索引(maker-core 各 agent 适配层、model-providers 目录、桌面端渲染层等);范围限开源客户端仓库 makecindy/cindy 的 desktop/mobile/packages,服务端不开源、不在范围
2. **配套 skill**:定义触发时机、检索优先级、如何带引用回答;与现有 `get_capabilities` 互补(它是静态能力清单,本服务是可检索的文档/源码知识)
3. **维护策略**:优先「能力文档 + 源码索引」,而非全量源码文档化,控制维护成本与过时风险

## 备选方案 / Alternatives considered

- 仅增强 `get_capabilities`(能力清单加详细说明),不提供检索 —— 不够,无法回答「某模块怎么实现」
- 仅做 skill 固定工作流,不提供自由检索 —— 覆盖面窄
- 全量源码文档化 —— 维护成本高、易过时
---
**OS**: win32 x64 (10.0.26200)
**界面语言**: zh-CN

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing get_capabilities and about-cindy entry points, then inspect the desktop, mobile, packages, maker-core, and model-providers areas named in the issue. Define the MCP search/fetch scope and the companion skill before implementation. Done means an official, maintainable way to retrieve the specified documentation and source indexes with the proposed scope and citations.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
developer-experience, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.