mcp-metricool

Instructions

Implementation Reference

• src/mcp_metricool/tools/tools.py:689-704 (handler)

  The handler function implementing the get_metrics tool logic, including registration via @mcp.tool() decorator. It retrieves available metrics for a given network using the network_subject_metrics dictionary.

  @mcp.tool()
  async def get_metrics(network: str) -> str | dict[str, Any]:
      """
      Retrieve the available metrics for a specific network.
      Args:
          network: Specific network to get the available metrics.
      """
      if network not in network_subject_metrics:
          return f"Incorrect network '{network}'. The available networks are: {', '.join(network_subject_metrics.keys())}"
      else:
          metrics = {}
          subjects = list(network_subject_metrics[network].keys())
          for subj in subjects:
              metrics[subj] = network_subject_metrics[network][subj]
          return {"metrics": metrics,
                  "instructions": "Stop the chat, show the metrics and let the user choose the metrics they want to analyze before going again to get_analytics, the user must choose before you continue."}

• src/mcp_metricool/utils/utils.py:8-133 (helper)

  Supporting dictionary that maps networks to subjects and available metrics, directly used in the get_metrics handler to list metrics.

  network_subject_metrics = {
          "tiktok": {
              "videos": [
                  "videos", "views", "comments", "shares", "interactions", "likes",
                  "reach", "engagement", "impressionSources", "averageVideoViews"
              ],
              "account": [
                  "video_views", "profile_views", "followers_count", "followers_delta_count",
                  "likes", "comments", "shares"
              ]
          },
          "pinterest": {
              "pins": [
                  "impression", "save", "pin_click", "outbound_click", "video_mrc_view",
                  "video_avg_watch_time", "video_v50_watch_time", "quartile_95_percent_view", "pins"
              ],
              "account": [
                  "followers", "following", "delta followers", "IMPRESSION", "ENGAGEMENT_RATE",
                  "ENGAGEMENT", "PIN_CLICK", "OUTBOUND_CLICK", "SAVE"
              ],
              "posts": [
                  "PINS"
              ]
          },
          "youtube": {
              "videos": [
                  "views", "interactions", "likes", "dislikes", "comments", "shares"
              ],
              "account": [
                  "yttotalSubscribers", "ytestimatedRevenue", "ytVideos", "ytsubscribersGained",
                  "ytsubscribersLost"
              ]
          },
          "facebook": {
              "stories": [
                  "storiesCount"
              ],
              "posts": [
                  "count", "interactions", "engagement", "impressionsunique", "impressions",
                  "clicks", "comments", "shares", "reactions"
              ],
              "reels": [
                  "blue_reels_play_count", "post_impressions_unique", "post_video_likes_by_reaction_type",
                  "post_video_social_actions", "engagement", "count"
              ],
              "account": [
                  "page_posts_impressions", "page_actions_post_reactions_total", "postsCount", "postsInteractions",
                  "likes", "pageFollows", "pageImpressions", "pageImpressions.M", "pageImpressions.F",
                  "pageImpressions.U", "pageImpressions.13-17", "pageImpressions.18-24", "pageImpressions.25-34",
                  "pageImpressions.35-44", "pageImpressions.45-54", "pageImpressions.55-64",
                  "pageImpressions.65+", "pageViews"
              ]
          },
          "gmb": {
              "business": [
                  "business_impressions_maps", "business_impressions_search", "business_impressions_total",
                  "business_direction_requests", "call_clicks", "website_clicks", "clicks_total",
                  "business_conversations", "business_bookings", "business_food_orders", "business_actions_total"
              ]
          },
          "instagram": {
              "account": [
                  "email_contacts", "get_directions_clicks", "phone_call_clicks", "text_message_clicks",
                  "clicks_total", "postsCount", "postsInteractions", "followers", "friends"
              ],
              "posts": [
                  "count", "interactions", "engagement", "reach", "impressions", "likes",
                  "comments", "saves", "shares"
              ],
              "reels": [
                  "count", "comments", "likes", "saved", "shares", "engagement", "impressions",
                  "reach", "interactions", "videoviews"
              ]
          },
          "linkedin": {
              "account": [
                  "followers", "paidFollowers", "companyImpressions", "deltaFollowers"
              ],
              "posts": [
                  "posts", "clicks", "likes", "comments", "shares", "engagement",
                  "impressions", "interactions"
              ],
              "stories": [
                  "inStoriesEngagement", "inStoriesInteractions", "inStoriesImpressions",
                  "inStoriesCliks", "inStories"
              ]
          },
          "threads": {
              "posts": [
                  "count", "views", "likes", "replies", "reposts", "engagement",
                  "quotes", "interactions"
              ],
              "account": [
                  "followers_count", "delta_followers"
              ]
          },
          "bluesky": {
              "posts": [
                  "posts_count", "interactions", "likes", "replies", "reposts", "quotes"
              ],
              "account": [
                  "followers_count", "follows_count", "count", "follow_event", "unfollow_event"
              ]
          },
          "webpage": {
              "account": [
                  "PageViews", "SessionsCount", "Visitors", "DailyPosts", "DailyComments"
              ]
          },
          "twitter": {
              "account": [
                  "twitterFollowers", "twFriends", "twTweets", "follows", "unfollows",
                  "twEngagement", "twImpressions", "twInteractions", "twFavorites",
                  "twRetweets", "twReplies", "twQuotes", "twProfileClicks",
                  "twLinkClicks"
              ]
          },
          "twitch": {
              "account": [
                  "TotalFollowers", "TotalSubscribers", "TotalVideos", "DeltaFollowers",
                  "TotalTier1", "TotalTier2", "TotalTier3", "TotalGifts", "TotalViews",
                  "TotalDuration"
  
              ]
          }
      }