Skip to main content

Crate oak_mcp

Crate oak_mcp 

Source
Expand description

ยง๐Ÿ› ๏ธ Developer Guide

This directory contains the core logic implementation of the project. Below are instructions for a quick start.

ยง๐Ÿšฆ Quick Start

ยงCore API Usage

// Example: Basic calling workflow
fn main() {
    // 1. Initialization
    // 2. Execute core logic
    // 3. Handle returned results
}

ยง๐Ÿ” Module Description

  • lib.rs: Exports public interfaces and core traits.
  • parser/ (if exists): Implements specific syntax parsing logic.
  • ast/ (if exists): Defines the syntax tree structure.

ยง๐Ÿ—๏ธ Architecture Design

The project follows the general architectural specifications of the Oak ecosystem, emphasizing:

  1. Immutability: Uses the Green/Red Tree structure to ensure efficient sharing of syntax trees.
  2. Fault Tolerance: Core logic is highly inclusive of erroneous input.
  3. Scalability: Convenient for downstream tools to perform secondary development.

Structsยง

JsonRpcError
Error information for a JSON-RPC response.
JsonRpcNotification
Represents a JSON-RPC 2.0 notification.
JsonRpcRequest
Represents a JSON-RPC 2.0 request.
JsonRpcResponse
Represents a JSON-RPC 2.0 response.
McpServer
A generic MCP server that wraps an Oak language service.
NoSemanticSearch
A default implementation of SemanticSearch that does nothing.

Traitsยง

SemanticSearch
Trait for semantic search implementations.