logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

prompt-formatter-from-docs

Converts technical manuals sourced from GitHub repos or dedicated web portals into optimized, context-rich inputs suitable for large language models during AI application execution.

Author

prompt-formatter-from-docs logo

Melbourneandrew

Apache License 2.0

Quick Info

GitHub GitHub Stars 0
NPM Weekly Downloads 0
Tools 1
Last Updated 2026-02-19

Tags

documentationapisdocs2promptdocumentation githubdocs2prompt mcpmelbourneandrew docs2prompt

Server Implementation for Prompt Generation Utility

License

The [docs2prompt] utility (originating from [Reza Tabrizi]'s work) is a Python package designed to ingest documentation, whether stored in a remote GitHub repository or accessible via a specific URL, and reformat it into highly effective prompts tailored for Large Language Models (LLMs).

This specific repository hosts an MCP (Model Context Protocol) service wrapper around the core docs2prompt functionality, enabling seamless integration with various MCP-compatible clients (such as Cursor, Claude, Windsurf, etc.).

Development Server Startup

  1. Acquire and install the uv package manager:

curl -LsSf https://astral.sh/uv/install.sh | sh

  1. Obtain a local copy of the source code:

git clone https://github.com/Melbourneandrew/docs2prompt-mcp

  1. Configure your MCP client by placing the following structure in its settings file. Remember to substitute the local path and optionally include your GitHub authorization credential for enhanced API access:

{ "mcpServers": { "docs2prompt": { "command": "uv", "args": [ "--directory", "/YOUR/LOCAL/PATH/docs2prompt-mcp/src", "run", "main.py" ], "env": { "GITHUB_TOKEN": "" } } } }

For assistance setting up the connection in popular clients, consult these references: * Cursor Client Integration * Claude Desktop Setup Guide

WIKIPEDIA: XMLHttpRequest (XHR) is an API in the form of a JavaScript object whose methods transmit HTTP requests from a web browser to a web server. The methods allow a browser-based application to send requests to the server after page loading is complete, and receive information back. XMLHttpRequest is a component of Ajax programming. Prior to Ajax, hyperlinks and form submissions were the primary mechanisms for interacting with the server, often replacing the current page with another one.

== History == The concept behind XMLHttpRequest was conceived in 2000 by the developers of Microsoft Outlook. The concept was then implemented within the Internet Explorer 5 browser (1999). However, the original syntax did not use the XMLHttpRequest identifier. Instead, the developers used the identifiers ActiveXObject("Msxml2.XMLHTTP") and ActiveXObject("Microsoft.XMLHTTP"). As of Internet Explorer 7 (2006), all browsers support the XMLHttpRequest identifier. The XMLHttpRequest identifier is now the de facto standard in all the major browsers, including Mozilla's Gecko layout engine (2002), Safari 1.2 (2004) and Opera 8.0 (2005).

=== Standards === The World Wide Web Consortium (W3C) published a Working Draft specification for the XMLHttpRequest object on April 5, 2006. On February 25, 2008, the W3C published the Working Draft Level 2 specification. Level 2 added methods to monitor event progress, allow cross-site requests, and handle byte streams. At the end of 2011, the Level 2 specification was absorbed into the original specification. At the end of 2012, the WHATWG took over development and maintains a living document using Web IDL.

== Usage == Generally, sending a request with XMLHttpRequest has several programming steps.

Create an XMLHttpRequest object by calling a constructor: Call the "open" method to specify the request type, identify the relevant resource, and select synchronous or asynchronous operation: For an asynchronous request, set a listener that will be notified when the request's state changes: Initiate the request by calling the "send" method: Respond to state changes in the event listener. If the server sends response data, by default it is captured in the "responseText" property. When the object stops processing the response, it changes to state 4, the "done" state. Aside from these general steps, XMLHttpRequest has many options to control how the request is sent and how the response is processed. Custom header fields can be added to the request to indicate how the server should fulfill it, and data can be uploaded to the server by providing it in the "send" call. The response can be parsed from the JSON format into a readily usable JavaScript object, or processed gradually as it arrives rather than waiting for the entire text. The request can be aborted prematurely or set to fail if not completed in a specified amount of time.

== Cross-domain requests ==

In the early development of the World Wide Web, it was found possible to brea

See Also

`