embedded-debugger-mcp 0.1.0

A Model Context Protocol server for embedded debugging with probe-rs - supports ARM Cortex-M, RISC-V debugging via J-Link, ST-Link, and more
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

//! Error types for the debugger MCP server

use thiserror::Error;

/// Main error type for the debugger MCP server
#[derive(Error, Debug)]
pub enum DebugError {
    #[error("Probe not found: {0}")]
    ProbeNotFound(String),

    #[error("Target not supported: {0}")]
    TargetNotSupported(String),

    #[error("Connection failed: {0}")]
    ConnectionFailed(String),

    #[error("Invalid session ID: {0}")]
    InvalidSession(String),

    #[error("Session limit exceeded (max: {0})")]
    SessionLimitExceeded(usize),

    #[error("Operation timeout")]
    OperationTimeout,

    #[error("Invalid address: 0x{0:08x}")]
    InvalidAddress(u64),

    #[error("Memory access failed: {0}")]
    MemoryAccessFailed(String),

    #[error("Breakpoint limit exceeded")]
    BreakpointLimitExceeded,

    #[error("RTT not available")]
    RttNotAvailable,

    #[error("RTT error: {0}")]
    RttError(String),

    #[error("Flash operation failed: {0}")]
    FlashOperationFailed(String),

    #[error("Invalid configuration: {0}")]
    InvalidConfig(String),

    #[error("Probe error: {0}")]
    ProbeError(String),

    #[error("IO error: {0}")]
    IoError(#[from] std::io::Error),

    #[error("Serialization error: {0}")]
    SerializationError(#[from] serde_json::Error),

    #[error("Internal error: {0}")]
    InternalError(String),
}

impl From<probe_rs::Error> for DebugError {
    fn from(error: probe_rs::Error) -> Self {
        DebugError::ProbeError(error.to_string())
    }
}

impl From<anyhow::Error> for DebugError {
    fn from(error: anyhow::Error) -> Self {
        DebugError::InternalError(error.to_string())
    }
}

/// Result type alias for convenience
pub type Result<T> = std::result::Result<T, DebugError>;

/// RTT specific errors
#[derive(Error, Debug)]
pub enum RttError {
    #[error("Control block not found")]
    ControlBlockNotFound,

    #[error("Channel not found: {0}")]
    ChannelNotFound(usize),

    #[error("Buffer overflow")]
    BufferOverflow,

    #[error("Attach failed: {0}")]
    AttachFailed(String),

    #[error("Read timeout")]
    ReadTimeout,
}

impl From<RttError> for DebugError {
    fn from(error: RttError) -> Self {
        DebugError::RttError(error.to_string())
    }
}

/// Target control errors
#[derive(Error, Debug)]
pub enum TargetError {
    #[error("Target not halted")]
    TargetNotHalted,

    #[error("Target not running")]
    TargetNotRunning,

    #[error("Reset failed: {0}")]
    ResetFailed(String),

    #[error("Halt failed: {0}")]
    HaltFailed(String),

    #[error("Step failed: {0}")]
    StepFailed(String),
}

impl From<TargetError> for DebugError {
    fn from(error: TargetError) -> Self {
        DebugError::InternalError(error.to_string())
    }
}

/// Memory operation errors
#[derive(Error, Debug)]
pub enum MemoryError {
    #[error("Read failed at address 0x{address:08x}: {reason}")]
    ReadFailed { address: u64, reason: String },

    #[error("Write failed at address 0x{address:08x}: {reason}")]
    WriteFailed { address: u64, reason: String },

    #[error("Invalid memory range: 0x{start:08x}-0x{end:08x}")]
    InvalidRange { start: u64, end: u64 },

    #[error("Memory region not accessible: 0x{address:08x}")]
    NotAccessible { address: u64 },
}

impl From<MemoryError> for DebugError {
    fn from(error: MemoryError) -> Self {
        DebugError::MemoryAccessFailed(error.to_string())
    }
}

/// Flash operation errors
#[derive(Error, Debug)]
pub enum FlashError {
    #[error("Flash erase failed: {0}")]
    EraseFailed(String),

    #[error("Flash program failed: {0}")]
    ProgramFailed(String),

    #[error("Flash verify failed: {0}")]
    VerifyFailed(String),

    #[error("Flash not writable")]
    NotWritable,

    #[error("Invalid flash address: 0x{0:08x}")]
    InvalidAddress(u64),
}

impl From<FlashError> for DebugError {
    fn from(error: FlashError) -> Self {
        DebugError::FlashOperationFailed(error.to_string())
    }
}