README.md•2.68 kB
# Payments Developer Portal MCP Server
A Model Context Protocol (MCP) server implementation that connects to a payments company's developer portal hosted on Firebase. This server provides AI assistants with access to payment documentation, APIs, and guides through the [MCP TypeScript SDK](https://github.com/modelcontextprotocol/typescript-sdk).
## What is MCP?
The [Model Context Protocol (MCP)](https://modelcontextprotocol.io) lets you build servers that expose data and functionality to LLM applications in a secure, standardized way. Think of it like a web API, but specifically designed for LLM interactions.
MCP servers can:
- Expose data through Resources
- Provide functionality through Tools
- Define interaction patterns through Prompts
## Getting Started
### Prerequisites
- Node.js (v16 or higher)
- npm
- Firebase hosting running locally at http://localhost:4000 with documentation content
### Installation
```bash
# Clone the repository
git clone <repository-url>
cd MCP-portal-new
# Install dependencies
npm install
```
### Running the Server
```bash
# Build the project
npm run build
# Run the MCP server
npm start
```
### Development
For development with automatic reloading:
```bash
# For development with auto-reload
npm run dev
```
## Available Features
### MCP Server
#### Tools
- `search_docs`: Search the developer portal documentation
- `get_resource_by_id`: Get a specific resource by its ID
- `list_categories`: List all available documentation categories
- `list_resources_by_category`: List resources in a specific category
- `list_resources_by_tag`: List resources with a specific tag
- `get_related_resources`: Get resources related to a specific resource
### Resources
- `payments-docs://api`: Access API reference documentation
- `payments-docs://documentation`: Access general documentation
- `payments-docs://guides`: Access guides and tutorials
- `payments-docs://categories`: View documentation categories
- `payments-docs://tags`: View documentation tags
## Documentation Structure
The MCP server connects to a Firebase hosting at http://localhost:4000 which contains:
- API references (JSON files)
- Documentation (Markdown files)
- Guides (Markdown files)
- Categories and tags organization
The server uses a docs-index.json file that contains metadata about all documentation resources, including:
- Resource ID, title, description, and path
- Resource type (api, documentation, guide, reference)
- Topics and related resources
- Categorization and tagging information
## Testing
You can test your MCP server using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).
## License
ISC