Content
50%Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
The body is a well-structured, mostly executable endpoint reference with sensible cost guidance, but it is bloated by repeated parameter text and broken multi-line JSON in several examples, and lacks validation/cost checkpoints and any progressive-disclosure split.
Suggestions
Fix the broken JSON in the investor/people/company/job-search examples by folding searchParams inside the -d body object (e.g., -d '{"api":"fiber","path":"/v1/people-search","body":{"searchParams":{...}}}') so the commands are copy-paste ready.
Deduplicate the repeated getDetailedEducation/getDetailedWorkExperience parameter blurbs (state once and reference it) or move the full per-endpoint parameter tables into a references/ file to improve conciseness and progressive disclosure.
Add a short workflow with a cost-validation checkpoint before paginating paid searches (e.g., check pageSize cost, inspect the returned cursor/count, confirm with the user before fetching additional pages) to raise workflow clarity.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body mostly respects Claude's intelligence (no "what is LinkedIn" filler) and is parameter/code-focused, but identical getDetailedEducation/getDetailedWorkExperience descriptions are repeated verbatim across ~6 endpoints and the entire ~360-line API reference is inlined, so it 'could be tightened' rather than earning the lean score-3 anchor. | 2 / 3 |
Actionability | Each endpoint ships a concrete curl command with headers and example bodies, but four examples (investor-search, people-search, company-search, job-search) place their "searchParams" JSON outside the closed -d string, producing broken shell/JSON that is not copy-paste ready, matching 'some concrete guidance but incomplete' rather than fully executable score-3. | 2 / 3 |
Workflow Clarity | A setup sequence (read credentials, export vars, instruct login if missing) is present, but there are no validation checkpoints (e.g., verify the key exported) and no cost/batch feedback loop before paginating $0.02/record searches, so per the batch-operations guideline workflow clarity is capped at 2. | 2 / 3 |
Progressive Disclosure | Sections (Cost Reference, Setup, Capabilities, Usage, Use Cases) give real structure and no references exist to be deep-nested, but this is a ~360-line monolithic inline API reference that could live in a separate file, matching the score-2 '200 lines of API reference that could be in a separate file' example rather than the one-level-deep reference pattern. | 2 / 3 |
Total | 8 / 12 Passed |