get_package_readme
Fetch the README of a Swift package from GitHub to understand its functionality, usage, and documentation before integration.
Instructions
Fetch the README of a Swift package from GitHub.
This is a QUERY tool — read-only, safe to call multiple times.
Use this after search_swift_packages to get details about a specific package. The owner and repo values come from search results (e.g. "apple" and "swift-nio").
Args: owner: GitHub repository owner (user or org). Example: "Alamofire". repo: GitHub repository name. Example: "Alamofire". max_length: Maximum characters to return (default 4000). Set to 0 for full content. Larger values use more tokens.
Returns the README content as markdown. If the README is longer than max_length, it is truncated with a note about the full length.
After reading the README, you can suggest the package to the user with its Swift Package Index URL: https://swiftpackageindex.com/{owner}/{repo}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| owner | Yes | ||
| repo | Yes | ||
| max_length | No |