loading…
Browse all
Xen Orchestra Server
FreeNot checkedEnables management of Xen Orchestra (XOA) via its REST API, including listing VMs, backup jobs, logs, and repositories.
About
Enables management of Xen Orchestra (XOA) via its REST API, including listing VMs, backup jobs, logs, and repositories.
README
��# X e n O r c h e s t r a M C P S e r v e r =����
! [ ] ( i c o n . p n g )
A M o d e l C o n t e x t P r o t o c o l ( M C P ) s e r v e r w r i t t e n i n =�
�P y t h o n t o m a n a g e =����X e n O r c h e s t r a ( X O A ) v i a i t s R E S T A P I .
T h e p r o j e c t i s c u r r e n t l y u n d e r h e a v y d e v e l o p m e n t . R u n t h e S e r v e r o n y o u r o w n r i s k .
# # =�-� P u r p o s e
T h i s M C P s e r v e r p r o v i d e s t o o l s t o m a n a g e a n d r e t r i e v e i n f o r m a t i o n f r o m X e n O r c h e s t r a u s i n g t h e R E S T A P I .
# # =�)� F e a t u r e s
- g e t _ d o c s - G e t t h e s w a g g e r d o c s f r o m t h e X e n O r c h e s t r a A P I .
- l i s t _ v m s - L i s t V M s w i t h t h e i r f i e l d s b a s e d o n f i l t e r s a n d l i m i t .
- c r e a t e _ v m ( u n d e r c o n s t r u c t i o n <����) - C r e a t e a V M b y p r o v i d i n g a J S O N p a y l o a d .
- d e l e t e _ v m ( u n d e r c o n s t r u c t i o n <����) - D e l e t e a V M g i v e n i t s U U I D o r h r e f .
- m o d i f y _ v m ( u n d e r c o n s t r u c t i o n <����) - M o d i f y V M p r o p e r t i e s n a m e _ l a b e l a n d / o r n a m e _ d e s c r i p t i o n .
- * * l i s t _ b a c k u p _ j o b s * * - L i s t b a c k u p j o b s w i t h t h e i r f i e l d s b a s e d o n f i l t e r s a n d l i m i t .
- * * g e t _ b a c k u p _ j o b _ d e t a i l s * * - L i s t b a c k u p j o b d e t a i l s b a s e d o n t h e b a c k u p j o b i d .
- * * l i s t _ b a c k u p _ l o g s * * - L i s t b a c k u p l o g s w i t h t h e i r f i e l d s b a s e d o n f i l t e r s a n d l i m i t .
- * * g e t _ b a c k u p _ l o g _ d e t a i l s * * - L i s t b a c k u p l o g s d e t a i l s b a s e d o n t h e b a c k u p l o g i d .
- * * l i s t _ b a c k u p _ r e p o s i t o r i e s * * - L i s t b a c k u p r e p o s i t o r i e s w i t h t h e i r f i e l d s b a s e d o n f i l t e r s a n d l i m i t .
- * * g e t _ b a c k u p _ r e p o s i t o r y _ d e t a i l s * * - L i s t b a c k u p r e p o s i t o r y d e t a i l s b a s e d o n t h e b a c k u p r e p o s i t o r y i d .
# # �&� P r e r e q u i s i t e s
- =� � D o c k e r D e s k t o p w i t h M C P T o o l k i t e n a b l e d ( t h e d o c k e r m c p C L I ) .
- =���� X e n O r c h e s t r a i n s t a n c e r e a c h a b l e f r o m t h e h o s t r u n n i n g t h e c o n t a i n e r .
- =�� X e n O r c h e s t r a a u t h e n t i c a t i o n t o k e n ( c r e a t e i t i n t h e X O A U I u n d e r y o u r u s e r , c h e c k o u t t h e [ o f f i c a l d o c u m e n t a t i o n ] ( h t t p s : / / d o c s . x c p - n g . o r g / m a n a g e m e n t / m a n a g e - a t - s c a l e / x o - a p i / ) i f y o u n e e d h e l p ) .
C h e c k o u t t h e [ i n s t a l l a t i o n i n s t r u c t i o n s ] ( I n s t a l l a t i o n . m d ) f o r d e t a i l e d i n f o r m a t i o n o n h o w t o s e t u p t h e D o c k e r M C P S e r v e r a n d y o u r M C P c l i e n t .
# # =���� E n v i r o n m e n t v a r i a b l e s
- X O A _ U R L : B a s e U R L o f y o u r X e n O r c h e s t r a i n s t a n c e ( e . g . h t t p s : / / x o a . e x a m p l e . l a n ) * * n o t r a i l i n g s l a s h * * .
- X O A _ T O K E N : T h e a u t h e n t i c a t i o n t o k e n c r e a t e d i n X e n O r c h e s t r a U I .
- C E R T _ V E R I F Y ( o p t i o n a l , d e f a u l t s t o T r u e ) : W h e t h e r t h e S S L c e r t i f i c a t e o f y o u r X e n O r c h e s t r a w e b s e r v e r s h o u l d b e c h e c k e d o r n o t . Y o u c a n a l s o p r o v i d e a p a t h t o y o u r c e r t i f i c a t e i n t h e c o n t a i n e r s f i l e s y s t e m : / p a t h / t o / y o u r / c e r t . p e m * * A d d t h e c e r t a s V o l u m e f o r t h i s t o w o r k * *
# # =��� E x a m p l e P r o m p t s
1 . L i s t a l l r u n n i n g v m s
2 . L i s t a l l s t o p p e d V M s w i t h t h e i r n a m e a n d t a g s
3 . T e l l m e w h a t b a c k u p j o b s i h a v e c o n f i g u r e d
4 . L i s t a l l o f m y m e t a d a t a b a c k u p s
5 . P r o v i d e a l l d e t a i l s f o r m y f u l l b a c k u p s
6 . L i s t t h e 5 l a s t f a i l e d b a c k u p s
7 . L i s t t h e l o g s f o r t h e 1 0 l a s t f u l l b a c k u p s
8 . L i s t l o g d e t a i l s f o r t h e l a s t f a i l e d b a c k u p - - > L i s t m o r e d e t a i l e d l o g s f o r t h i s b a c k u p
9 . L i s t a l l b a c k u p r e p o s i t o r i e s - - > L i s t d e t a i l s f o r t h e < y o u r - r e p o s i t o r y - n a m e > b a c k u p r e p o s i t o r y
# # =��� A r c h i t e c t u r e
C l i e n t �! D o c k e r M C P G a t e w a y �! X e n O r c h e s t r a M C P S e r v e r ( t h i s p r o j e c t ) �! X e n O r c h e s t r a R E S T A P I
S e c r e t s : X O A _ T O K E N s h o u l d b e p r o v i d e d t h r o u g h D o c k e r D e s k t o p s e c r e t s o r a n . e n v f i l e .
# # =�,� D e v e l o p m e n t / L o c a l t e s t i n g
S e t e n v i r o n m e n t v a r i a b l e s l o c a l l y f o r t e s t i n g :
b a s h e x p o r t X O A _ U R L = " h t t p s : / / x o a . e x a m p l e . l a n " e x p o r t X O A _ T O K E N = " y o u r - t o k e n - h e r e " p y t h o n m a i n . p y
How to install
Run in your terminal:
claude mcp add xen-orchestra-mcp-server -- npx 
