Skip to content

Commit a194715

Browse files
authored
Merge pull request #3 from SocialAPIsHub/fix/readme-v1.0.3-full-tool-list-and-honest-limitations
docs: README — list all 47 tools + honest about aggregation limits (v1.0.3)
2 parents b117ff3 + 927c38a commit a194715

2 files changed

Lines changed: 114 additions & 33 deletions

File tree

README.md

Lines changed: 113 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -114,50 +114,131 @@ Get Nike's Facebook page details
114114

115115
## 🛠️ Available Tools
116116

117-
### Facebook Pages
118-
- `facebook_get_page_id` - Extract page ID from URL
119-
- `facebook_get_page_details` - Get page info, followers, likes
120-
- `facebook_get_page_posts` - Fetch posts with time filtering
121-
- `facebook_get_page_reels` - Get reels/short videos
122-
123-
### Facebook Groups
124-
- `facebook_get_group_id` - Extract group ID from URL
125-
- `facebook_get_group_details` - Get group metadata
126-
- `facebook_get_group_posts` - Fetch group posts
127-
128-
### Facebook Posts
129-
- `facebook_get_post_id` - Extract post ID from URL
130-
- `facebook_get_post_details` - Get reactions, comments, shares
131-
- `facebook_get_post_attachments` - Get media attachments
132-
- `facebook_get_video_details` - Get video metadata
133-
- `facebook_get_post_comments` - Fetch comments with pagination
134-
135-
**More platforms coming soon:** Instagram, TikTok, YouTube, Twitter
117+
47 tools across Facebook and Instagram. Every tool maps 1:1 to a REST endpoint on `api.socialapis.io` — pricing notes in each tool description indicate per-call credit cost.
118+
119+
### Facebook — Pages
120+
- `facebook_get_page_id` — Extract page ID from URL
121+
- `facebook_get_page_details` — Page info, followers, likes, category. Set `exact_followers_count=true` for the exact integer (charges 5 credits instead of 1)
122+
- `facebook_get_page_posts` — Fetch posts with `after_time` / `before_time` for date filtering. `limit` 3-9, charges scale per `ceil(returned / 3)`
123+
- `facebook_get_page_videos` — Page videos, `limit` 6-12
124+
- `facebook_get_page_reels` — Reels / short videos
125+
126+
### Facebook — Groups
127+
- `facebook_get_group_id` — Extract group ID from URL
128+
- `facebook_get_group_metadata` — Lightweight metadata (name, id, cover image)
129+
- `facebook_get_group_details` — Full details (members, description, rules)
130+
- `facebook_get_group_posts` — Group posts, same `limit` + date filtering as page posts
131+
- `facebook_get_group_videos` — Group videos
132+
133+
### Facebook — Posts
134+
- `facebook_get_post_id` — Extract post ID from URL
135+
- `facebook_get_post_details` — Reactions, comments count, shares, media
136+
- `facebook_get_post_attachments` — Full media attachments (5 credits per call)
137+
- `facebook_get_video_details` — Video post metadata + stats
138+
- `facebook_get_post_comments` — Top-level comments, `limit` up to 30
139+
- `facebook_get_comment_replies` — Replies to a specific comment
140+
141+
### Facebook — Search
142+
- `facebook_search_pages` — Search pages by keyword + optional location filter
143+
- `facebook_search_people` — Search public profiles by keyword
144+
- `facebook_search_locations` — Look up Facebook location UIDs (for use in other endpoints)
145+
- `facebook_search_posts` — Search posts by keyword, recency, location
146+
- `facebook_search_videos` — Search Facebook Watch videos
147+
148+
### Facebook — Ads Library (Meta Ad Transparency)
149+
- `facebook_ads_search` — Search ads by keyword, country, status
150+
- `facebook_ads_page_details` — All ads from a specific page
151+
- `facebook_ads_archive_details` — Full ad archive details
152+
- `facebook_ads_keywords` — Search ads by keyword
153+
- `facebook_ads_countries` — List of supported country codes
154+
155+
### Facebook — Marketplace
156+
- `facebook_marketplace_search` — Item search with location, price, category, condition filters
157+
- `facebook_marketplace_listing` — Single listing details
158+
- `facebook_marketplace_seller` — Seller profile + their listings
159+
- `facebook_marketplace_categories` — Browse category hierarchy
160+
- `facebook_marketplace_city_coordinates` — Lat/long for a city (for radius search)
161+
- `facebook_marketplace_vehicles` — Vehicle-specific listing search
162+
- `facebook_marketplace_rentals` — Rental property listings
163+
164+
### Facebook — Media
165+
- `facebook_download_media` — Direct download URL for FB media (images, videos)
166+
167+
### Instagram — Profile
168+
- `instagram_get_user_id` — Resolve username → numeric ID
169+
- `instagram_get_profile_details` — Profile info, follower count, bio, post count
170+
- `instagram_get_profile_posts` — Recent posts from a profile
171+
- `instagram_get_profile_reels` — Reels from a profile
172+
- `instagram_get_profile_highlights` — Story highlights list
173+
- `instagram_get_highlight_details` — Full content of a specific highlight
174+
175+
### Instagram — Posts + Reels
176+
- `instagram_get_post_id` — Resolve post URL → ID
177+
- `instagram_get_post_details` — Likes, comments, media, caption
178+
- `instagram_get_reels_feed` — Reels feed for a profile
179+
- `instagram_get_reels_by_audio` — Reels using a specific audio/music ID
180+
181+
### Instagram — Discovery
182+
- `instagram_popular_search` — Trending queries / suggestions
183+
- `instagram_get_location_posts` — Posts tagged at a specific location
184+
- `instagram_get_nearby_locations` — Nearby location IDs (for use in location-posts)
185+
186+
### Coming soon
187+
- TikTok (videos, profiles, hashtags)
188+
- X / Twitter (tweets, profiles, search)
189+
- LinkedIn (company pages, posts, employees)
190+
- YouTube (videos, channels, comments)
191+
192+
Track the platform roadmap at [socialapis.io/api-sources](https://socialapis.io/api-sources).
136193

137194
---
138195

139-
## 💡 Usage Examples
196+
## 💡 Usage examples
140197

141-
### Brand Monitoring
142-
```
143-
Monitor Nike's Facebook page and alert me if engagement drops below average
144-
```
198+
Each prompt below is a real Claude Desktop session. Some of these are single-tool-call patterns ("get me X"); some require Claude to chain multiple calls + aggregate the results (noted where).
145199

146-
### Competitive Analysis
147-
```
148-
Compare engagement rates between Nike, Adidas, and Puma over the last month
149-
```
200+
### Single-call patterns (fast, cheap)
150201

151-
### Content Strategy
152202
```
153-
What types of posts get the most engagement on Coca-Cola's Facebook page?
203+
What's Nike's follower count on Facebook?
204+
→ Uses facebook_get_page_details (1 credit)
205+
206+
Get the latest 9 posts from facebook.com/EngenSA
207+
→ Uses facebook_get_page_posts with limit=9 (1-3 credits depending on actual returned count)
208+
209+
Show me the Meta ads currently running for "Apple Vision Pro" in Germany
210+
→ Uses facebook_ads_search (1 credit)
154211
```
155212

156-
### Sentiment Analysis
213+
### Multi-call patterns (Claude orchestrates these — but it's slower + more expensive)
214+
157215
```
158-
Analyze comments on our recent posts and identify common themes
216+
Compare engagement on Nike vs Adidas's last 9 Facebook posts
217+
→ Claude calls facebook_get_page_posts twice (~2-6 credits total),
218+
aggregates reactions/comments/shares per post, returns a comparison.
219+
220+
What are people saying in the comments on Coca-Cola's last 3 posts?
221+
→ Claude calls facebook_get_page_posts (1 credit) then
222+
facebook_get_post_comments 3 times (3 credits) and summarizes.
223+
224+
Show me marketplace listings for "PlayStation 5" under $400 in Berlin
225+
→ Claude calls facebook_marketplace_city_coordinates (1 credit) +
226+
facebook_marketplace_search with filters (1 credit).
159227
```
160228

229+
### What this MCP server does NOT do
230+
231+
Some queries look natural in a chat ("compare engagement over the last month") but require aggregations the API doesn't expose as a single tool yet. Claude can still answer them, but it'll fan out into many tool calls — which is slow + expensive.
232+
233+
| Query shape | Why it's hard |
234+
|---|---|
235+
| "Engagement rate over the last 30 days" for a page | Requires fetching every post in the date range (paginated, `limit` capped at 9 per call) and computing engagement per post. Hits the LLM tool-call budget on busy pages. |
236+
| "Compare engagement rates between Brand A, B, C over the last month" | Same problem, 3× — one paginated fetch per brand, then comparison math. Works for small windows; slow for "last month" on high-volume pages. |
237+
| Historical archive older than what Facebook itself serves | We surface what Facebook makes publicly visible. Posts that scrolled off Facebook's visible feed aren't retrievable. |
238+
| Server-side time-series (daily engagement, weekly growth) | Not yet — on the roadmap as a future `engagement-stats` endpoint with built-in aggregation. |
239+
240+
If your use case maps to one of these patterns and you want the aggregation pre-computed instead of LLM-orchestrated, [contact support](https://socialapis.io/contact-us) with the specific query — we're prioritizing the aggregation endpoint based on customer demand.
241+
161242
---
162243

163244
## 🏗️ Architecture

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@socialapis/mcp",
3-
"version": "1.0.2",
3+
"version": "1.0.3",
44
"description": "MCP server and client for SocialAPIs - Access social media data in Claude, Cursor, and any MCP-compatible tool",
55
"mcpName": "io.github.SocialAPIsHub/social-media-api",
66
"type": "module",

0 commit comments

Comments
 (0)