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

Uploaded Python 3

File details

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

File metadata

  • Download URL: hc_mcp_api_docs-0.1.2.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.2.tar.gz
Algorithm Hash digest
SHA256 d3a8d989e7ef00a4fd9f2c84827d3e8d66713b0396e4117136a6dad3f1eff6db
MD5 4fcdeb520d786d508210cbf9515a7006
BLAKE2b-256 6f34a2eb202cf583a37e7a3bf5cd6be00bff1751174d0c6547ddb830c78afc30

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for hc_mcp_api_docs-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8dd23b9c8038066099de42ed29ec7c6412ae71cdc858201e630b2479c5677a7e
MD5 c7f73a41c3a449c1328cd02982f08159
BLAKE2b-256 8cb695fe56da6d97e275970db9ed4165b9e8a098da2e6b545db9f3c17762bd48

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