Safe Haskell	None
Language	Haskell2010

Network.MCP.Transport.Types

Synopsis

class Transport t where
- handleMessages :: t -> (Message -> IO (Maybe Message)) -> IO ()
data Message
data Request = Request {
- requestJsonrpc :: JSONRPC
- requestId :: Value
- requestMethod :: Text
- requestParams :: Maybe Value
}
data Response = Response {
- responseJsonrpc :: JSONRPC
- responseId :: Value
- responseResult :: Maybe Value
- responseError :: Maybe ErrorResponse
}
data Notification = Notification {
- notificationJsonrpc :: JSONRPC
- notificationMethod :: Text
- notificationParams :: Maybe Value
}
data ErrorResponse = ErrorResponse {
- errorCode :: Int
- errorMessage :: Text
- errorData :: Maybe Value
}
data TransportError = TransportError String
newtype JSONRPC = JSONRPC {
- unJSONRPC :: Text
}

Documentation

class Transport t where Source #

Transport interface for all transport implementations

Methods

handleMessages :: t -> (Message -> IO (Maybe Message)) -> IO () Source #

Keep processing messages using the provided handler. Will only return if the transport mechanism signals termination; e.g. EOF on a socket or similar.

Instances

Instances details

Transport STDIOTransport Source #	A simple, synchronous transport implementation using standard input/output.
Instance details Defined in Network.MCP.Transport.StdIO Methods handleMessages :: STDIOTransport -> (Message -> IO (Maybe Message)) -> IO () Source #

data Message Source #

Combined message type for the transport layer

Constructors

RequestMessage Request
ResponseMessage Response
NotificationMessage Notification

Instances

Instances details

FromJSON Message Source #
Instance details Defined in Network.MCP.Transport.Types Methods parseJSON :: Value -> Parser Message # parseJSONList :: Value -> Parser [Message] # omittedField :: Maybe Message #
ToJSON Message Source #
Instance details Defined in Network.MCP.Transport.Types Methods toJSON :: Message -> Value # toEncoding :: Message -> Encoding # toJSONList :: [Message] -> Value # toEncodingList :: [Message] -> Encoding # omitField :: Message -> Bool #
Show Message Source #
Instance details Defined in Network.MCP.Transport.Types Methods showsPrec :: Int -> Message -> ShowS # show :: Message -> String # showList :: [Message] -> ShowS #
Eq Message Source #
Instance details Defined in Network.MCP.Transport.Types Methods (==) :: Message -> Message -> Bool # (/=) :: Message -> Message -> Bool #

data Request Source #

JSON-RPC Request

Constructors

Request
Fields requestJsonrpc :: JSONRPC requestId :: Value requestMethod :: Text requestParams :: Maybe Value

Instances

Instances details

FromJSON Request Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

parseJSON :: Value -> Parser Request #

parseJSONList :: Value -> Parser [Request] #

omittedField :: Maybe Request #

ToJSON Request Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

toJSON :: Request -> Value #

toEncoding :: Request -> Encoding #

toJSONList :: [Request] -> Value #

toEncodingList :: [Request] -> Encoding #

omitField :: Request -> Bool #

Generic Request Source #

Instance details

Defined in Network.MCP.Transport.Types

Associated Types

type Rep Request

Instance details

Defined in Network.MCP.Transport.Types

type Rep Request = D1 ('MetaData "Request" "Network.MCP.Transport.Types" "hs-mcp-0.1.1.0-JLoh9r68iDo86RtGS2ufDf" 'False) (C1 ('MetaCons "Request" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestJsonrpc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JSONRPC) :*: S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value)) :*: (S1 ('MetaSel ('Just "requestMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "requestParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)))))

Methods

from :: Request -> Rep Request x #

to :: Rep Request x -> Request #

Show Request Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

showsPrec :: Int -> Request -> ShowS #

show :: Request -> String #

showList :: [Request] -> ShowS #

Eq Request Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

(==) :: Request -> Request -> Bool #

(/=) :: Request -> Request -> Bool #

type Rep Request Source #

Instance details

Defined in Network.MCP.Transport.Types

type Rep Request = D1 ('MetaData "Request" "Network.MCP.Transport.Types" "hs-mcp-0.1.1.0-JLoh9r68iDo86RtGS2ufDf" 'False) (C1 ('MetaCons "Request" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestJsonrpc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JSONRPC) :*: S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value)) :*: (S1 ('MetaSel ('Just "requestMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "requestParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)))))

data Response Source #

JSON-RPC Response

Constructors

Response
Fields responseJsonrpc :: JSONRPC responseId :: Value responseResult :: Maybe Value responseError :: Maybe ErrorResponse

Instances

Instances details

FromJSON Response Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

parseJSON :: Value -> Parser Response #

parseJSONList :: Value -> Parser [Response] #

omittedField :: Maybe Response #

ToJSON Response Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

toJSON :: Response -> Value #

toEncoding :: Response -> Encoding #

toJSONList :: [Response] -> Value #

toEncodingList :: [Response] -> Encoding #

omitField :: Response -> Bool #

Generic Response Source #

Instance details

Defined in Network.MCP.Transport.Types

Associated Types

type Rep Response

Instance details

Defined in Network.MCP.Transport.Types

type Rep Response = D1 ('MetaData "Response" "Network.MCP.Transport.Types" "hs-mcp-0.1.1.0-JLoh9r68iDo86RtGS2ufDf" 'False) (C1 ('MetaCons "Response" 'PrefixI 'True) ((S1 ('MetaSel ('Just "responseJsonrpc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JSONRPC) :*: S1 ('MetaSel ('Just "responseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value)) :*: (S1 ('MetaSel ('Just "responseResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "responseError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ErrorResponse)))))

Methods

from :: Response -> Rep Response x #

to :: Rep Response x -> Response #

Show Response Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

showsPrec :: Int -> Response -> ShowS #

show :: Response -> String #

showList :: [Response] -> ShowS #

Eq Response Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

(==) :: Response -> Response -> Bool #

(/=) :: Response -> Response -> Bool #

type Rep Response Source #

Instance details

Defined in Network.MCP.Transport.Types

type Rep Response = D1 ('MetaData "Response" "Network.MCP.Transport.Types" "hs-mcp-0.1.1.0-JLoh9r68iDo86RtGS2ufDf" 'False) (C1 ('MetaCons "Response" 'PrefixI 'True) ((S1 ('MetaSel ('Just "responseJsonrpc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JSONRPC) :*: S1 ('MetaSel ('Just "responseId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Value)) :*: (S1 ('MetaSel ('Just "responseResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)) :*: S1 ('MetaSel ('Just "responseError") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ErrorResponse)))))

data Notification Source #

JSON-RPC Notification (no ID)

Constructors

Notification
Fields notificationJsonrpc :: JSONRPC notificationMethod :: Text notificationParams :: Maybe Value

Instances

Instances details

FromJSON Notification Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

parseJSON :: Value -> Parser Notification #

parseJSONList :: Value -> Parser [Notification] #

omittedField :: Maybe Notification #

ToJSON Notification Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

toJSON :: Notification -> Value #

toEncoding :: Notification -> Encoding #

toJSONList :: [Notification] -> Value #

toEncodingList :: [Notification] -> Encoding #

omitField :: Notification -> Bool #

Generic Notification Source #

Instance details

Defined in Network.MCP.Transport.Types

Associated Types

type Rep Notification

Instance details

Defined in Network.MCP.Transport.Types

type Rep Notification = D1 ('MetaData "Notification" "Network.MCP.Transport.Types" "hs-mcp-0.1.1.0-JLoh9r68iDo86RtGS2ufDf" 'False) (C1 ('MetaCons "Notification" 'PrefixI 'True) (S1 ('MetaSel ('Just "notificationJsonrpc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JSONRPC) :*: (S1 ('MetaSel ('Just "notificationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "notificationParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)))))

Methods

from :: Notification -> Rep Notification x #

to :: Rep Notification x -> Notification #

Show Notification Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

showsPrec :: Int -> Notification -> ShowS #

show :: Notification -> String #

showList :: [Notification] -> ShowS #

Eq Notification Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

(==) :: Notification -> Notification -> Bool #

(/=) :: Notification -> Notification -> Bool #

type Rep Notification Source #

Instance details

Defined in Network.MCP.Transport.Types

type Rep Notification = D1 ('MetaData "Notification" "Network.MCP.Transport.Types" "hs-mcp-0.1.1.0-JLoh9r68iDo86RtGS2ufDf" 'False) (C1 ('MetaCons "Notification" 'PrefixI 'True) (S1 ('MetaSel ('Just "notificationJsonrpc") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 JSONRPC) :*: (S1 ('MetaSel ('Just "notificationMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "notificationParams") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)))))

data ErrorResponse Source #

JSON-RPC Error Response

Constructors

ErrorResponse
Fields errorCode :: Int errorMessage :: Text errorData :: Maybe Value

Instances

Instances details

FromJSON ErrorResponse Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

parseJSON :: Value -> Parser ErrorResponse #

parseJSONList :: Value -> Parser [ErrorResponse] #

omittedField :: Maybe ErrorResponse #

ToJSON ErrorResponse Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

toJSON :: ErrorResponse -> Value #

toEncoding :: ErrorResponse -> Encoding #

toJSONList :: [ErrorResponse] -> Value #

toEncodingList :: [ErrorResponse] -> Encoding #

omitField :: ErrorResponse -> Bool #

Generic ErrorResponse Source #

Instance details

Defined in Network.MCP.Transport.Types

Associated Types

type Rep ErrorResponse

Instance details

Defined in Network.MCP.Transport.Types

type Rep ErrorResponse = D1 ('MetaData "ErrorResponse" "Network.MCP.Transport.Types" "hs-mcp-0.1.1.0-JLoh9r68iDo86RtGS2ufDf" 'False) (C1 ('MetaCons "ErrorResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "errorData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)))))

Methods

from :: ErrorResponse -> Rep ErrorResponse x #

to :: Rep ErrorResponse x -> ErrorResponse #

Show ErrorResponse Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

showsPrec :: Int -> ErrorResponse -> ShowS #

show :: ErrorResponse -> String #

showList :: [ErrorResponse] -> ShowS #

Eq ErrorResponse Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

(==) :: ErrorResponse -> ErrorResponse -> Bool #

(/=) :: ErrorResponse -> ErrorResponse -> Bool #

type Rep ErrorResponse Source #

Instance details

Defined in Network.MCP.Transport.Types

type Rep ErrorResponse = D1 ('MetaData "ErrorResponse" "Network.MCP.Transport.Types" "hs-mcp-0.1.1.0-JLoh9r68iDo86RtGS2ufDf" 'False) (C1 ('MetaCons "ErrorResponse" 'PrefixI 'True) (S1 ('MetaSel ('Just "errorCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: (S1 ('MetaSel ('Just "errorMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "errorData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Value)))))

data TransportError Source #

Transport error

Constructors

TransportError String

Instances

Instances details

Exception TransportError Source #
Instance details Defined in Network.MCP.Transport.Types Methods toException :: TransportError -> SomeException # fromException :: SomeException -> Maybe TransportError # displayException :: TransportError -> String # backtraceDesired :: TransportError -> Bool #
Show TransportError Source #
Instance details Defined in Network.MCP.Transport.Types Methods showsPrec :: Int -> TransportError -> ShowS # show :: TransportError -> String # showList :: [TransportError] -> ShowS #
Eq TransportError Source #
Instance details Defined in Network.MCP.Transport.Types Methods (==) :: TransportError -> TransportError -> Bool # (/=) :: TransportError -> TransportError -> Bool #

newtype JSONRPC Source #

Constructors

JSONRPC
Fields unJSONRPC :: Text

Instances

Instances details

FromJSON JSONRPC Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

parseJSON :: Value -> Parser JSONRPC #

parseJSONList :: Value -> Parser [JSONRPC] #

omittedField :: Maybe JSONRPC #

ToJSON JSONRPC Source #

Instance details

Defined in Network.MCP.Transport.Types

Methods

toJSON :: JSONRPC -> Value #

toEncoding :: JSONRPC -> Encoding #

toJSONList :: [JSONRPC] -> Value #

toEncodingList :: [JSONRPC] -> Encoding #

omitField :: JSONRPC -> Bool #

Generic JSONRPC Source #

Instance details

Defined in Network.MCP.Transport.Types

Associated Types

type Rep JSONRPC
Instance details Defined in Network.MCP.Transport.Types type Rep JSONRPC = D1 ('MetaData "JSONRPC" "Network.MCP.Transport.Types" "hs-mcp-0.1.1.0-JLoh9r68iDo86RtGS2ufDf" 'True) (C1 ('MetaCons "JSONRPC" 'PrefixI 'True) (S1 ('MetaSel ('Just "unJSONRPC") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))