Used as the underlying web framework for the MCP Server, providing high performance endpoints and routing capabilities.
Referenced for version control of the project, with specific patterns excluded via .gitignore.
Hosts the repository for the MCP Server project at iamsumit-git/eai_mcp.
The programming language requirement (3.8+) for running the MCP Server.
Enables fetching ring reports through the download_ring_report tool which accepts mplsCloud parameters.
Used for dependency management and project metadata via pyproject.toml file.
Absolutely! Here’s a professional and clear README template for your MCP Server project, tailored for your use case (MCP Server on EAI existing service). You can copy, edit, and expand as needed.
MCP Server for EAI Services
This project implements an MCP (Multi-Channel Platform) Server that integrates with existing EAI (Enterprise Application Integration) services. It provides a set of tools and endpoints to interact with EAI’s SyncJobManagement and CommonService APIs, enabling secure, automated, and programmatic access to network reports and management features.
Features
- Fetch and Download Reports:
Retrieve cable, segment, and ring reports from EAI’s SyncJobManagement and CommonService endpoints. - Secure Authentication:
Uses basic authentication for secure API access. - Extensible Tools:
Easily add new tools for additional EAI endpoints. - FastAPI-based Server:
Built on FastAPI for high performance and easy deployment.
Project Structure
Requirements
Install dependencies:
or, if using pyproject.toml
:
Usage
- Configure Authentication
UpdateBASIC_AUTH_USERNAME
andBASIC_AUTH_PASSWORD
inserver.py
with your EAI credentials. - Run the ServerThe server will start on
0.0.0.0:8000
by default. - Available Tools
fetch_sync_job_management_report(report_name: str)
download_ring_report(mplsCloud: str)
These tools can be called via the MCP interface or extended as needed.
Security
- Credentials:
Do not commit sensitive credentials to the repository. - SSL:
Use thecerts/
directory for CA certificates if required by your environment.
Extending
To add new tools/endpoints, define a new function in server.py
and decorate it with @mcp.tool()
.
License
This project is for internal use. Contact the author for licensing details.
Author
Sumit (iamsumit-git)
GitHub Repo
more sections (e.g., API examples, troubleshooting, contributing) or want this written directly to your README.md
!
This server cannot be installed
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Implements a Multi-Channel Platform Server that integrates with existing Enterprise Application Integration services, providing tools and endpoints to securely fetch network reports and access management features.
Related MCP Servers
- -securityFlicense-qualityA powerful integration server that combines Netbox's network infrastructure management capabilities with MCP (Multi-Cloud Platform) functionality.Last updated -Python
- -securityAlicense-qualityA lightweight gateway server that provides a unified connection entry point for accessing multiple MCP servers, supporting various protocols including Network and Local Transports.Last updated -PythonApache 2.0
- -securityFlicense-qualityA multi-tenant remote server platform that enables applications to connect to Model Context Protocol servers over WebSocket connections, allowing secure access to file management, database, and API capabilities.Last updated -2JavaScript
- -securityFlicense-qualityServer that enables integration with Microsoft Business Central through its REST API, providing functionality for customer and product management, sales orders, and generic API interactions.Last updated -Python