> ## Documentation Index
> Fetch the complete documentation index at: https://docs.apinizer.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Portal Usage with Model Context Protocol (MCP)

> API Portal provides tools that offer various API management functions using the Model Context Protocol (MCP) standard. These tools are MCP-accessible versions of the API Portal Management API. Provides full API lifecycle support covering all processes from API discovery to deployment and monitoring, can work over both HTTP and WebSocket connections, and optimizes API integration, testing, and debugging operations for developers.

## Overview

The API Portal project contains tools that provide various API management functions using the Model Context Protocol (MCP) standard. These tools are MCP-accessible versions of the API Portal Management API.

<CardGroup cols={2}>
  <Card title="Full API Lifecycle Support" icon="circle-nodes">
    Covers all processes from API discovery to deployment and monitoring
  </Card>

  <Card title="Dual Protocol Support" icon="network-wired">
    Can work over both HTTP and WebSocket connections
  </Card>

  <Card title="Optimized for Developers" icon="code">
    Tools optimized for API integration, testing, and debugging
  </Card>

  <Card title="Secure Authentication" icon="shield">
    Bearer token-based secure access control
  </Card>

  <Card title="Real-Time Analytics" icon="chart-line">
    API usage, performance, and traffic analysis
  </Card>

  <Card title="Automatic Token Management" icon="key">
    Automatic token acquisition for JWT and OAuth2 protocols
  </Card>
</CardGroup>

## Target Users

<CardGroup cols={2}>
  <Card title="API Developers" icon="user-gear">
    For API integration and testing operations
  </Card>

  <Card title="DevOps Teams" icon="server">
    For API monitoring and performance analysis
  </Card>

  <Card title="Project Managers" icon="chart-bar">
    For API usage statistics and reports
  </Card>

  <Card title="QA Teams" icon="flask">
    For API test scenarios and validation operations
  </Card>
</CardGroup>

## Technical Requirements

* Valid Apinizer Portal account
* APINIZER-TOKEN authentication header
* MCP compatible client (Claude, VS Code extensions, etc.)
* Internet connection (for API Portal access)

<Info>
  MCP (Model Context Protocol) provides client-server communication using the JSON-RPC 2.0 protocol. Unlike HTTP REST API, this protocol offers bidirectional messaging over persistent connections, cannot be tested directly with tools like curl/Postman, and requires special MCP clients like Claude Desktop.
</Info>

## API Management and Discovery

<CardGroup cols={2}>
  <Card title="search_apis" icon="magnifying-glass">
    Search and filter APIs on the Portal. Can search by name, category, tags, etc.
  </Card>

  <Card title="get_api_details" icon="info">
    Get detailed information of a specific API. API metadata, endpoints, category names, and documentation
  </Card>

  <Card title="get_api_spec" icon="file-code">
    Get API's OpenAPI (Swagger) specification. All endpoints, schemas, and examples
  </Card>

  <Card title="get_api_access_url" icon="link">
    Get API's full access URL. Base URL for testing operations
  </Card>

  <Card title="get_api_auth_info" icon="key">
    Get API's authentication information. JWT/OAuth2 server addresses and client information
  </Card>

  <Card title="get_api_plans" icon="tags">
    List API's available plans. FREE, SUBSCRIPTION, METERED, and TIERED plan details
  </Card>

  <Card title="get_api_applications" icon="layer-group">
    List applications registered to a specific API
  </Card>

  <Card title="get_categories" icon="folder">
    List all API categories in the portal. Returns category IDs and names
  </Card>
</CardGroup>

## Application Management

<CardGroup cols={2}>
  <Card title="search_apps" icon="magnifying-glass">
    List and search applications owned by the user
  </Card>

  <Card title="create_app" icon="plus">
    Create new application with automatic API key generation. Used to group API subscriptions
  </Card>

  <Card title="get_app_details" icon="info">
    Get detailed information of a specific application
  </Card>

  <Card title="get_app_apis" icon="layer-group">
    List APIs registered to the application
  </Card>

  <Card title="get_app_registrations" icon="list">
    List all API registrations of the application
  </Card>

  <Card title="delete_app" icon="trash">
    Delete application (all registrations and credentials are also deleted)
  </Card>

  <Card title="get_available_apis_for_app" icon="check">
    List available APIs for the application
  </Card>
</CardGroup>

## API Registration and Subscription

<CardGroup cols={2}>
  <Card title="register_api_to_application" icon="link">
    Register application to an API and select a plan
  </Card>
</CardGroup>

## Credentials Management

<CardGroup cols={2}>
  <Card title="get_app_credentials" icon="key">
    List all API keys of the application (including username/password values)
  </Card>

  <Card title="add_api_key" icon="plus">
    Add new API key to the application
  </Card>

  <Card title="get_credential_details" icon="info">
    Get detailed information of a specific credential (including real values)
  </Card>

  <Card title="delete_credential" icon="trash">
    Delete and revoke API key
  </Card>
</CardGroup>

## Token and Authentication

<CardGroup cols={2}>
  <Card title="get_token" icon="key">
    Get JWT/OAuth2 access token. Supports automatic or manual mode
  </Card>
</CardGroup>

## API Testing

<CardGroup cols={2}>
  <Card title="test_api" icon="flask">
    Test API endpoints. Send HTTP requests and receive responses
  </Card>
</CardGroup>

## Analytics and Statistics

<CardGroup cols={2}>
  <Card title="get_api_traffic" icon="chart-line">
    Get API traffic analytics data. Volume, patterns, and usage trends
  </Card>

  <Card title="get_api_response_time" icon="clock">
    API response time analytics. Latency trends and performance statistics
  </Card>

  <Card title="get_api_stats" icon="chart-bar">
    General API statistics. Request count, error rates, usage patterns
  </Card>

  <Card title="query_api_traffic" icon="magnifying-glass">
    Detailed traffic queries. Complex filtering, sorting, and aggregation features
  </Card>
</CardGroup>

## Helper Tools

<CardGroup cols={2}>
  <Card title="hello" icon="hand-wave">
    Get greeting message from Apinizer API Portal (connection test)
  </Card>
</CardGroup>

## Important Notes

<Note>
  **Authentication**: All tools require `APINIZER-TOKEN` header
</Note>

<Note>
  **Two Protocols**: Both HTTP and WebSocket protocols are supported
</Note>

<Note>
  **Testing Operations**: To test API, first get base URL with `get_api_access_url`, then add the endpoint
</Note>

<Warning>
  **Credentials**: `get_app_credentials` and `get_credential_details` return real API Key/Secret values. Store this information securely.
</Warning>

<Note>
  **Authorization**: Application owners can only access their own applications
</Note>