get_repo_documentation
Retrieves and analyzes repository documentation files, including README, API docs, and user guides, to provide structured analysis results.
Instructions
Retrieve and analyze repository documentation files.
Searches for and analyzes documentation within the repository, including:
- README files
- API documentation
- Design documents
- User guides
- Installation instructions
- Other documentation files
Args:
repo_path (str): Path or URL matching what was originally provided to clone_repo
Returns:
dict: Documentation analysis results with format:
{
"status": str, # "success", "error", or "waiting"
"message": str, # Only for error/waiting status
"documentation": { # Only for success status
"files": [
{
"path": str, # Relative path in repo
"category": str, # readme, api, docs, etc.
"format": str # markdown, rst, etc.
}
],
"directories": [
{
"path": str,
"doc_count": int
}
],
"stats": {
"total_files": int,
"by_category": dict,
"by_format": dict
}
}
}
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| branch | No | ||
| repo_path | Yes | ||
| cache_strategy | No | shared |