---
title: Newsfeed
description: "Optional. The stories the workspace's newsfeed follows. 1 tool."
group: newsfeed
tools: [newsfeed.read]
source: [packages/agents/src/tools/features.ts]
generated: true
---

> Roadstar docs for agents. Every page, as markdown: https://docs.roadstar.app/llms.txt

Optional research tools: today's stories from the workspace's newsfeed, the separate Newsfeed screen in Pro.

## How to use it

What `find_tools` sends with these tools, word for word:

> The workspace's newsfeed: stories it follows for the workspace's projects.

## Tools

| Tool | What it does | Owner's yes |
| --- | --- | --- |
| [newsfeed.read](#read) | Today's stories and what the feed follows | No |

## read

`newsfeed.read` · Today's stories and what the feed follows.

**Owner's yes:** No. Nothing of the owner's changes.

No input.

Returns:

```ts
{
  stories: NewsfeedStory[];
  projects: {
    id: string;
    name: string;
  }[];
  topics: {
    label: string;
    projectIds: string[];
  }[];
  accounts: {
    handle: string;
    projectIds: string[];
    addedAt: string;
  }[];
  market: {
    stories: NewsfeedStory[];
    read: {
      sentences: {
        text: string;
        storyIds: string[];
      }[];
      previous: string[];
      writtenAt: string;
      rewrites: number;
    } | null;
  };
  brief: {
    writtenAt: string;
    projects: {
      projectId: string;
      effect: "direct" | "indirect" | "quiet";
      text: string;
    }[];
  } | null;
  actions: {
    kind: "match" | "follow" | "unfollow";
    text: string;
    at: string;
  }[];
  today: {
    counts: NewsfeedCount[];
    stories: number;
  };
  strip: {
    symbol: string;
    name: string;
    price: number;
    changePercent: number;
  }[];
  pricedAt: string | null;
  moves: Record<string, number>;
  publishers: string[];
  checkedAt: string | null;
}
```

## Types

Named types in the results above.

```ts
type NewsfeedStory = {
  id: string;
  kind: "x" | "web";
  headline: string;
  summary: string;
  reason: string | null;
  watchLabel: string;
  fromMarket: boolean;
  projectIds: string[];
  tickers: string[];
  sources: {
    url: string;
    title: string | null;
  }[];
  posts: {
    handle: string;
    name: string | null;
    text: string;
    url: string;
    postedAt: string;
  }[];
  happenedAt: string;
}

type NewsfeedCount = {
  kind: "x" | "web" | "news";
  read: number;
  kept: number;
}
```