Browse Source

docs: add API key instructions for MCP host mode (#7496)

### What problem does this PR solve?

_Briefly describe what this PR aims to solve. Include background context
that will help reviewers understand the purpose of the PR._

### Type of change

- [ ] Bug Fix (non-breaking change which fixes an issue)
- [ ] New Feature (non-breaking change which adds functionality)
- [x] Documentation Update
- [ ] Refactoring
- [ ] Performance Improvement
- [ ] Other (please describe):

---------

Co-authored-by: 马继龙 <majilong@ideal.com>
tags/v0.19.0
Monster-Beast 5 months ago
parent
commit
539876af11
No account linked to committer's email address
1 changed files with 19 additions and 0 deletions
  1. 19
    0
      docs/develop/mcp.md

+ 19
- 0
docs/develop/mcp.md View File



You are ready to brew🍺! You are ready to brew🍺!


#### Getting API Keys for Host Mode

When running the MCP server in `host` mode (by setting `--mcp-mode=host` in the configuration), each client needs to provide their own API key in requests. This API key is **different** from the `--mcp-host-api-key` specified in the server configuration.

To get a valid API key for use in your client scripts (like `test_mcp.py`):

1. Access the RAGFlow UI in your browser (typically `http://localhost:9380`)
2. Log in to your account
3. Click on your avatar/profile in the top-right corner
4. Select **API** from the dropdown menu
5. On the API page, generate a new API key or copy an existing one
6. Use this key in your client script as follows:

```python
# Client script example (test_mcp.py)
async with sse_client("http://localhost:9382/sse", headers={"api_key": "YOUR_KEY_HERE"}) as streams:
# Rest of your code...
```

## Testing and Usage ## Testing and Usage


Typically, there are various ways to utilize an MCP server. You can integrate it with LLMs or use it as a standalone tool. You find the way. Typically, there are various ways to utilize an MCP server. You can integrate it with LLMs or use it as a standalone tool. You find the way.

Loading…
Cancel
Save