Use the docs from an AI tool
Let your AI coding tool read this documentation while it writes code against the COMMITLY REST API. The COMMITLY docs MCP server answers questions about endpoints, fields, authentication and guides straight from these pages.
This is not AI Connect. The docs server is public and read-only: it knows the published documentation and nothing else — no COMMITLY account, no company data.
https://docs-mcp.commitly.com/Why use it
Section titled “Why use it”AI coding assistants know a lot about APIs in general and little about COMMITLY in particular. Without the docs, they fill the gaps with plausible guesses.
| Without the docs server | With the docs server |
|---|---|
| The assistant invents endpoints or field names that do not exist | It looks up the real operation and its schema before writing code |
| It guesses how authentication works | It reads the token flow: client credentials, 5-minute tokens, Bearer header |
It misses COMMITLY concepts such as leaf categories, scenarios or external_id |
It reads the concept pages and applies them |
| It needs the whole OpenAPI file pasted into the chat | It fetches just the operation or tag it needs |
| Its knowledge is as old as its training data | It always reads the current, published documentation |
Connect your tool
Section titled “Connect your tool”claude mcp add --transport http commitly-docs https://docs-mcp.commitly.com/Add the server to .cursor/mcp.json in your project (or ~/.cursor/mcp.json for all projects):
{ "mcpServers": { "commitly-docs": { "url": "https://docs-mcp.commitly.com/" } }}-
Open the Command Palette and run MCP: Add Server…
-
Choose HTTP.
-
Paste the URL and name the server
commitly-docs:https://docs-mcp.commitly.com/
Windsurf connects to remote servers through mcp-remote. Add this to ~/.codeium/windsurf/mcp_config.json:
{ "mcpServers": { "commitly-docs": { "command": "npx", "args": [ "-y", "mcp-remote", "https://docs-mcp.commitly.com/" ] } }}In the Claude app, open Settings → Connectors, choose Add custom connector, name it COMMITLY docs and paste the URL. There is no sign-in step.
https://docs-mcp.commitly.com/Try this
Section titled “Try this”Ask your tool, for example:
- “How does authentication work for the COMMITLY API? Show me a token request in Python.” — the tool searches the docs and reads the Authentication guide.
- “What parameters does the COMMITLY operation listTransactions accept?” — the tool fetches that operation from the OpenAPI description.
- “Write a Node.js job that syncs open invoices from our ERP to COMMITLY and deletes paid ones.” — the tool reads the open items use case and the invoice operations, including the warning about deleting without a selector.
- “How do I keep forecast budgets in sync with our CRM deals without creating duplicates?” — the tool reads Budgets and external IDs.
| Tool | Use it to |
|---|---|
get-commitly-docs-overview |
List every guide page with title, description and path |
search-commitly-docs |
Find guide pages and API operations by keyword |
get-commitly-docs-page |
Read one guide page as Markdown |
get-commitly-openapi-spec |
Get the OpenAPI definition of one operation or one tag, with the schemas it uses |
Technical details
Section titled “Technical details”| Endpoint | the server URL above |
| Transport | Streamable HTTP (JSON responses, no SSE stream) |
| Authentication | none |
| Data | the published pages of this documentation and the public OpenAPI file — updated with every release of these docs |
| Search | keyword search over titles, headings, text and API operations |
The complete OpenAPI file stays at commitly.com/developer/openapi.yaml; the server returns slices of it, not the whole file.

