how_to_use_deepwiki.md

How to Use DeepWiki

DeepWiki is a tool that provides AI-powered documentation search and Q&A for GitHub repositories. For Effect-TS questions, you can use it to get detailed answers about the Effect ecosystem.

Using DeepWiki with Claude Code

The DeepWiki MCP tool is available in Claude Code with three main functions:

1. Ask Questions About Effect

mcp__deepwiki__ask_question
Parameters:
- repoName: "Effect-TS/effect" (note the capital E and T)
- question: Your question about Effect

Example questions:

• "How to use Schema.optionalWith with default values?"
• "What are the best practices for error handling in Effect?"
• "How do branded types work in Effect Schema?"

2. Read Wiki Structure

mcp__deepwiki__read_wiki_structure
Parameters:
- repoName: "Effect-TS/effect"

This shows available documentation topics for the Effect repository.

3. Read Wiki Contents

mcp__deepwiki__read_wiki_contents
Parameters:
- repoName: "Effect-TS/effect"

This retrieves the full documentation contents.

Important Notes

• The repository name is case-sensitive: use Effect-TS/effect not effect-ts/effect
• DeepWiki provides context-aware answers based on the actual Effect codebase and documentation
• It understands Effect-specific concepts like pipeable APIs, branded types, layers, and services
• Answers include code examples from the actual Effect repository

Common Effect Topics to Ask About

• Effect Schema validation and transformations
• Layer composition and dependency injection
• Error handling with typed errors
• Concurrent and async operations
• Resource management with Scope
• Configuration and environment handling
• Testing strategies with Effect