alihan/mcpdoc
1
0
Fork 0
mirror of https://github.com/langchain-ai/mcpdoc.git synced 2025-10-19 03:18:14 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add local llms.txt file reading (#14)

Browse Source 
Add ability to read llms.txt from local files.

---------

Co-authored-by: Eugene Yurtsev <eyurtsev@gmail.com>
This commit is contained in:
Lance Martin
2025-03-27 10:22:42 -07:00
committed by GitHub
parent 1bc11f5ea1
commit c2977b3602
4 changed files with 226 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -20,6 +20,20 @@ curl -LsSf https://astral.sh/uv/install.sh | sh
#### Choose an `llms.txt` file to use.
* For example, [here's](https://langchain-ai.github.io/langgraph/llms.txt) the LangGraph `llms.txt` file.
> **Note: Security and Domain Access Control**
>
> For security reasons, mcpdoc implements strict domain access controls:
>
> 1. **Remote llms.txt files**: When you specify a remote llms.txt URL (e.g., `https://langchain-ai.github.io/langgraph/llms.txt`), mcpdoc automatically adds only that specific domain (`langchain-ai.github.io`) to the allowed domains list. This means the tool can only fetch documentation from URLs on that domain.
>
> 2. **Local llms.txt files**: When using a local file, NO domains are automatically added to the allowed list. You MUST explicitly specify which domains to allow using the `--allowed-domains` parameter.
>
> 3. **Adding additional domains**: To allow fetching from domains beyond those automatically included:
> - Use `--allowed-domains domain1.com domain2.com` to add specific domains
> - Use `--allowed-domains '*'` to allow all domains (use with caution)
>
> This security measure prevents unauthorized access to domains not explicitly approved by the user, ensuring that documentation can only be retrieved from trusted sources.
#### (Optional) Test the MCP server locally with your `llms.txt` file of choice:
```bash
uvx --from mcpdoc mcpdoc \