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.0.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.0-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: hc_mcp_api_docs-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 9922819947d6a3a4c68b6b4acc7b1846d6bf473bb597848805b3889d74ce91b3
MD5 ce003ad95283891cf91129307b803bda
BLAKE2b-256 fad69de07134f6af4b3621d8e83c1ed072a7baff9b89c6b63fa48d6d59d883bc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hc_mcp_api_docs-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c506e0efbce118935e1b774ec04d72f9a453afa651cbeb4e8162888bd9cd80a9
MD5 aaf99bafa8ab96357985eb24a17d4fc3
BLAKE2b-256 c15aae6399d959e4ca2a79ca2151a08f65132a75070c3c05aca722567a04ceff

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