Cangje Docs MCP

🚀 Cangjie Language Document Retrieval System - Claude Code Configuration Tutorial

This is an MCP server for Cangjie language document retrieval specifically designed for Claude Code. It allows you to efficiently query all documents of the Cangjie programming language directly in Claude Code.

🚀 Quick Start

Step 1: Download the MCP Executable File

• Download the Cangjie MCP executable file.

Step 2: Prepare the Document Directory

Method 1: Download the Official Documentation

# Clone the official documentation repository
git clone https://gitcode.com/Cangjie/CangjieCorpus.git

Method 2: Use Existing Documentation

Copy the Cangjie language documents to the directory where the executable file is located:

# Ensure there is a CangjieCorpus directory in the project root directory
# Or use the -dir parameter to specify the document directory

Step 3: Configure Claude Code

1. Open the Claude Code settings.
2. Find the MCP server configuration.
3. Add the following configuration:

{
  "mcpServers": {
    "cangjie-docs": {
      "command": "/path/to/cangje-docs-mcp",
      "args": ["-dir", "/path/to/CangjieCorpus"]
    }
  }
}

Step 4: Restart Claude Code

Restart Claude Code to load the new MCP server.

Add cj_syntax.md from this repository to CLAUDE.md, which is equivalent to having a copy of the Cangjie basic syntax in the context permanently (this may not be necessary if you are using an LLM fine - tuned for Cangjie).

💻 Usage Examples

Basic Query

Please help me find the syntax for function definition in the Cangjie language.

Categorized Search

I want to learn about the basic data types in the Cangjie language.

Learning Path

I'm a beginner. Please recommend a learning order for the Cangjie language.

Specific Question

How to handle concurrent programming in the Cangjie language?

API Query

Which APIs related to file operations are there in the Cangjie standard library?

🎯 Common Query Examples

Syntax Query

• "Variable declaration syntax in the Cangjie language"
• "How to define a class"
• "Control flow statements in Cangjie"

Concept Learning

• "Explain generic programming in the Cangjie language"
• "Error handling mechanism in Cangjie"
• "Package management system in Cangjie"

Practical Problems

• "How to read and write files in Cangjie"
• "Examples of network programming in Cangjie"
• "Interaction between Cangjie and JavaScript"

API Reference

• "Methods of the Cangjie String class"
• "Array operation APIs in Cangjie"
• "Usage of the Cangjie HTTP client"

🔧 Advanced Features

Specify Categorized Search

Please search for content about inheritance in the manual category.

Get Related Recommendations

Based on the topic of 'function definition', recommend relevant learning content.

Navigation and Browsing

Show the complete table of contents structure of the Cangjie documentation.

📋 Check Configuration

Verify Version Information

./cangje-docs-mcp -version

It should display:

Cangjie Language Document Retrieval System v1.0.0
Local document retrieval server based on the MCP protocol
Document version: v1.0.0 (Release date: 2025-07-01)

View Help

./cangje-docs-mcp -help

🛠️ Troubleshooting

Common Problems

Q: Claude Code cannot find the MCP server A: Check if the path in the configuration file is correct and ensure that the executable file has execution permissions.

Q: Search results are empty A: Confirm that the document directory exists and contains Cangjie documents, and check the permissions of the document directory.

Q: Prompt that the document directory does not exist during startup A: Use the -dir parameter to specify the correct document directory path.

Q: The MCP server fails to start A: Check if the configuration format is correct and ensure that the correct parameter format is used.

Correct MCP Configuration Format

{
  "mcpServers": {
    "cangje-docs": {
      "type": "stdio",
      "command": "/path/to/cangje-docs-mcp",
      "args": ["-dir", "/path/to/CangjieCorpus"],
      "env": {}
    }
  }
}

Important: Ensure that the "type": "stdio" and "env": {} fields are included.

Debug Mode

# Run the MCP server directly to view startup logs
./cangje-docs-mcp -dir /path/to/CangjieCorpus

# Check version information
./cangje-docs-mcp -version

# View help information
./cangje-docs-mcp -help

📚 Documentation

Document Directory Structure

Ensure that your document directory structure is as follows:

CangjieCorpus/
├── README.md
├── manual/              # Basic manual
│   ├── first_understanding/
│   ├── basic_data_type/
│   ├── function/
│   └── ...
├── libs/                # Standard library API
│   └── std/
├── tools/               # Development tools
└── extra/               # Additional content

🎉 Start Using

After the configuration is complete, you can naturally query all the document content of the Cangjie language in Claude Code! The system will automatically understand your questions and provide relevant document content and suggestions.