Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/ai-mcp
common/mcp-server-manager
MCPFrontendService
Interface MCPFrontendService
interface
MCPFrontendService
{
addOrUpdateServer
(
description
:
MCPServerDescription
)
:
Promise
<
void
>
;
getPromptTemplateId
(
serverName
:
string
)
:
string
;
getServerDescription
(
name
:
string
,
)
:
Promise
<
undefined
|
MCPServerDescription
>
;
getServerNames
()
:
Promise
<
string
[]
>
;
getStartedServers
()
:
Promise
<
string
[]
>
;
getTools
(
serverName
:
string
,
)
:
Promise
<
|
undefined
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
nextCursor
?:
string
;
tools
:
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
annotations
?:
{
destructiveHint
?:
boolean
;
idempotentHint
?:
boolean
;
openWorldHint
?:
boolean
;
readOnlyHint
?:
boolean
;
title
?:
string
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
icons
?:
{
mimeType
?:
string
;
sizes
?:
string
;
src
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
inputSchema
:
{
properties
?:
{
[
key
:
string
]:
unknown
}
;
required
?:
string
[]
;
type
:
"object"
;
[
key
:
string
]:
unknown
;
}
;
name
:
string
;
outputSchema
?:
{
properties
?:
{
[
key
:
string
]:
unknown
}
;
required
?:
string
[]
;
type
:
"object"
;
[
key
:
string
]:
unknown
;
}
;
title
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
;
hasServer
(
serverName
:
string
)
:
Promise
<
boolean
>
;
isServerStarted
(
serverName
:
string
)
:
Promise
<
boolean
>
;
registerToolsForAllStartedServers
()
:
Promise
<
void
>
;
startServer
(
serverName
:
string
)
:
Promise
<
void
>
;
stopServer
(
serverName
:
string
)
:
Promise
<
void
>
;
}
Implemented by
MCPFrontendServiceImpl
Index
Methods
add
Or
Update
Server
get
Prompt
Template
Id
get
Server
Description
get
Server
Names
get
Started
Servers
get
Tools
has
Server
is
Server
Started
register
Tools
For
All
Started
Servers
start
Server
stop
Server
Methods
add
Or
Update
Server
addOrUpdateServer
(
description
:
MCPServerDescription
)
:
Promise
<
void
>
Parameters
description
:
MCPServerDescription
Returns
Promise
<
void
>
get
Prompt
Template
Id
getPromptTemplateId
(
serverName
:
string
)
:
string
Parameters
serverName
:
string
Returns
string
get
Server
Description
getServerDescription
(
name
:
string
)
:
Promise
<
undefined
|
MCPServerDescription
>
Parameters
name
:
string
Returns
Promise
<
undefined
|
MCPServerDescription
>
get
Server
Names
getServerNames
()
:
Promise
<
string
[]
>
Returns
Promise
<
string
[]
>
get
Started
Servers
getStartedServers
()
:
Promise
<
string
[]
>
Returns
Promise
<
string
[]
>
get
Tools
getTools
(
serverName
:
string
,
)
:
Promise
<
|
undefined
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
nextCursor
?:
string
;
tools
:
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
annotations
?:
{
destructiveHint
?:
boolean
;
idempotentHint
?:
boolean
;
openWorldHint
?:
boolean
;
readOnlyHint
?:
boolean
;
title
?:
string
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
icons
?:
{
mimeType
?:
string
;
sizes
?:
string
;
src
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
inputSchema
:
{
properties
?:
{
[
key
:
string
]:
unknown
}
;
required
?:
string
[]
;
type
:
"object"
;
[
key
:
string
]:
unknown
;
}
;
name
:
string
;
outputSchema
?:
{
properties
?:
{
[
key
:
string
]:
unknown
}
;
required
?:
string
[]
;
type
:
"object"
;
[
key
:
string
]:
unknown
;
}
;
title
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
Parameters
serverName
:
string
Returns
Promise
<
|
undefined
|
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
nextCursor
?:
string
;
tools
:
{
_meta
?:
{
[
key
:
string
]:
unknown
}
;
annotations
?:
{
destructiveHint
?:
boolean
;
idempotentHint
?:
boolean
;
openWorldHint
?:
boolean
;
readOnlyHint
?:
boolean
;
title
?:
string
;
[
key
:
string
]:
unknown
;
}
;
description
?:
string
;
icons
?:
{
mimeType
?:
string
;
sizes
?:
string
;
src
:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
inputSchema
:
{
properties
?:
{
[
key
:
string
]:
unknown
}
;
required
?:
string
[]
;
type
:
"object"
;
[
key
:
string
]:
unknown
;
}
;
name
:
string
;
outputSchema
?:
{
properties
?:
{
[
key
:
string
]:
unknown
}
;
required
?:
string
[]
;
type
:
"object"
;
[
key
:
string
]:
unknown
;
}
;
title
?:
string
;
[
key
:
string
]:
unknown
;
}
[]
;
[
key
:
string
]:
unknown
;
}
,
>
has
Server
hasServer
(
serverName
:
string
)
:
Promise
<
boolean
>
Parameters
serverName
:
string
Returns
Promise
<
boolean
>
is
Server
Started
isServerStarted
(
serverName
:
string
)
:
Promise
<
boolean
>
Parameters
serverName
:
string
Returns
Promise
<
boolean
>
register
Tools
For
All
Started
Servers
registerToolsForAllStartedServers
()
:
Promise
<
void
>
Returns
Promise
<
void
>
start
Server
startServer
(
serverName
:
string
)
:
Promise
<
void
>
Parameters
serverName
:
string
Returns
Promise
<
void
>
stop
Server
stopServer
(
serverName
:
string
)
:
Promise
<
void
>
Parameters
serverName
:
string
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
add
Or
Update
Server
get
Prompt
Template
Id
get
Server
Description
get
Server
Names
get
Started
Servers
get
Tools
has
Server
is
Server
Started
register
Tools
For
All
Started
Servers
start
Server
stop
Server
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...