Skip to content

Oxide.md MCP Server #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Markdown Oxide Development Guide

## Build Commands
```bash
# Build the project
cargo build

# Run the binary
cargo run

# Run tests
cargo test

# Check code style and common issues
cargo clippy

# Format code
cargo fmt
```

## Code Style Guidelines
- **Imports**: Group by standard lib, external crates, then internal modules
- **Naming**: Use snake_case for variables/functions, CamelCase for types/traits
- **Error Handling**: Use `anyhow` for general errors, custom errors for specific cases
- **Documentation**: Document public APIs with rustdoc comments
- **Types**: Prefer strong typing with custom types over primitives
- **Async**: Use `async/await` consistently, avoid mixing with direct futures

## Development Approach
- **Planning**: For tasks that involve multiple steps or components, first state your implementation plan before writing code
- **Break Down Complex Tasks**: Identify the main components, dependencies, and sequence of implementation
- **State Your Plan**: Clearly outline:
- What files need to be created or modified
- The order of implementation
- Key design decisions or trade-offs
- **Then Implement**: After stating the plan, proceed with the actual code implementation

## Project Structure
- `src/vault/`: Core data management
- `src/completion/`: Editor completion providers
- `src/tokens.rs`: Markdown token parsing
- `src/main.rs`: Entry point and LSP server setup

## MCP Integration
MCP (Model Context Protocol) server implementation is in `src/mcp.rs`. Use this to access AI service integrations with Claude and other MCP-compatible clients.

For more information on MCP, see: https://modelcontextprotocol.io/llms-full.txt
Loading