Skip to main content

MCP server for our API documentation

Project description

HC MCP API Docs

MCP server for our API documentation. This server provides tools to interact with our API documentation system.

Features

  • List available APIs grouped by environment
  • Get detailed API information including documentation URLs
  • Search APIs by title and description
  • Generate code examples in TypeScript, Python, and cURL

Configuration

The server can be configured using environment variables:

  • API_DOCS_BASE_URL: Base URL for the API documentation.

Tools

list_apis

List our APIs grouped by environment. Returns titles, descriptions, accounts, and stages (max 100 APIs).

get_api_details

Get API documentation URLs, environment details, and OpenAPI spec. Returns JSON/YAML/Swagger UI links.

search_apis

Search APIs by title/description. Prioritizes title matches. Returns max 50 sorted results.

generate_code

Generate API client code with endpoints and error handling. Supports TypeScript, Python, cURL.

Installation

pip install hc-mcp-api-docs

Usage

The server can be used with any MCP client. Example using the Claude desktop app:

  1. Add the server to your MCP configuration
  2. Use the available tools through the MCP interface

Development

# Install dependencies
make prepare

# Build package
make build

# Upload to PyPI
make upload

# Install locally
make install

# Clean build artifacts
make clean

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hc_mcp_api_docs-0.1.1.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hc_mcp_api_docs-0.1.1-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file hc_mcp_api_docs-0.1.1.tar.gz.

File metadata

  • Download URL: hc_mcp_api_docs-0.1.1.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for hc_mcp_api_docs-0.1.1.tar.gz
Algorithm Hash digest
SHA256 24158c49785c3fbc878dc2f0675ff0e1d779fc066320085f33fdac6c12a588fb
MD5 9ea3c35f7e9286dc370963f8d28b6031
BLAKE2b-256 a3e2a2ed52e6a86e9f93f4b5b4329bd2db1c664d291b22488ceed57f1ebb953a

See more details on using hashes here.

File details

Details for the file hc_mcp_api_docs-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for hc_mcp_api_docs-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 869cf965d2c0721e94b4b2df3e5b94ebc71da63c7e7ed6f1029ad60926394bc1
MD5 0d9882a381ae22b3d83a63be929926f4
BLAKE2b-256 9767fa7e5d783c851912d7ddcc3fc10f332e8473ea81aa375e6fe30542cd1cfa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page