Galacean Document Sense

Provides a Model Context Protocol (MCP) server focused on Galacean engine documentation search. It exposes tools like search_documents and solve_requirement so MCP-compatible clients can retrieve complete markdown files, find relevant snippets by keyword, or map natural language requirements to solution steps.

Features

• Zero-config startup with STDIO transport.
• Fast in-memory indexing of the docs/ markdown folder.
• Keyword search with relevance scoring and contextual snippets.
• Direct document retrieval by slug (filename without .md).

Getting Started

npm install
npm run build
npm start

Using the tool

search_documents --query "animator state machine"
search_documents --doc render-pipeline
solve_requirement --requirement "获取屏幕输入点"

The tools respond with structured JSON, so MCP clients can render the results or continue the conversation with additional context.

Project Structure

docs/                # Markdown documentation corpus
src/
├── index.ts         # MCP entry point
├── server.ts        # STDIO server bootstrap
├── services/
│   └── docs-service.ts  # Document loading and search logic
└── tools/
    └── tools.ts     # Tool definitions

Scripts

• npm run build – Compile TypeScript and copy docs/ into dist/.
• npm start – Build the project and launch the MCP server.

License

MIT