@aventurevc/mcp-server 0.8.6 → 0.8.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,99 +1,84 @@
1
1
  # aVenture MCP server
2
2
 
3
- Give an AI client access to aVenture's research data on companies, people, funding,
4
- and news through the Model Context Protocol (MCP).
3
+ Give Claude, ChatGPT, or any MCP client access to aVenture research on private
4
+ companies, founders, investors, funding rounds, and news. aVenture hosts the
5
+ server, so there is nothing to install.
5
6
 
6
- Most clients need no install: connect them to the hosted server at
7
- `https://mcp.aventure.vc/mcp` and sign in with OAuth. Install this package only to
8
- run the server yourself, for example when your client cannot complete an OAuth
9
- sign-in. The [aVenture MCP quickstart](https://docs.aventure.vc/mcp) covers both
10
- paths.
7
+ You need an aVenture account; free and paid plans both work.
8
+ [Create an account](https://aventure.vc/sign-up).
11
9
 
12
- ## Connect to the hosted server
10
+ ## Get started in one step
13
11
 
14
- Configure your client with these settings:
12
+ Paste this into Claude, ChatGPT, Claude Code, or your AI app:
15
13
 
16
- - URL: `https://mcp.aventure.vc/mcp`
14
+ ```text
15
+ Connect the aVenture MCP server for me.
16
+ - URL: https://mcp.aventure.vc/mcp
17
17
  - Transport: Streamable HTTP
18
- - OAuth client ID: `KL7mINzGk0le0QiD`
19
- - Client secret: none; this is a public client
18
+ - OAuth client ID: KL7mINzGk0le0QiD
19
+ If you can add it yourself (in Claude Code, run
20
+ `claude mcp add --scope user --transport http --client-id KL7mINzGk0le0QiD --callback-port 6276 aventure https://mcp.aventure.vc/mcp`),
21
+ do that. Otherwise tell me exactly where to enter these settings in this app.
22
+ When it's connected and I've signed in, look up Stripe on aVenture to confirm
23
+ it works. Docs: https://docs.aventure.vc/mcp
24
+ ```
20
25
 
21
- The client discovers the authorization server from the MCP URL and signs in with
22
- authorization code and PKCE. Dynamic client registration is disabled, so enter the
23
- client ID explicitly. A client that accepts only a URL fails with
24
- `does not support dynamic client registration`.
26
+ ## MCP, CLI, or Researchly?
25
27
 
26
- For example, add the server to Claude Code for all your projects:
28
+ | Where you work | Use |
29
+ | --- | --- |
30
+ | Claude, ChatGPT, or another desktop, web, or cloud AI app | This MCP server |
31
+ | A terminal, shell scripts, or a coding agent with a shell | The [aVenture CLI](https://docs.aventure.vc/cli) |
32
+ | [Researchly](https://researchly.chat) | Nothing to install: open [Profile, then MCP servers](https://researchly.chat/profile/mcp-servers) and choose **Connect aVenture** |
27
33
 
28
- ```sh
29
- claude mcp add --scope user --transport http \
30
- --client-id KL7mINzGk0le0QiD --callback-port 6276 \
31
- aventure https://mcp.aventure.vc/mcp
32
- ```
34
+ ## Connect by hand
33
35
 
34
- Then run `/mcp` in Claude Code, select `aventure`, and complete browser sign-in.
36
+ Add a custom connector (or MCP server) in your app with these settings, then sign
37
+ in to aVenture in the browser window it opens:
35
38
 
36
- The registered redirect URIs are:
39
+ | Setting | Value |
40
+ | --- | --- |
41
+ | URL | `https://mcp.aventure.vc/mcp` |
42
+ | Transport | Streamable HTTP |
43
+ | OAuth client ID | `KL7mINzGk0le0QiD` |
37
44
 
38
- - `http://127.0.0.1/callback`
39
- - `http://localhost/callback`
40
- - `https://chatgpt.com/connector_platform_oauth_redirect`
41
- - `https://claude.ai/api/mcp/auth_callback`
45
+ - **Claude and ChatGPT**: add the URL as a custom connector, and enter the client
46
+ ID if the app asks for one.
47
+ - **Claude Code**: run the `claude mcp add` command from the prompt above, then run
48
+ `/mcp`, select `aventure`, and sign in.
49
+ - **Other clients**: enter the client ID in the OAuth settings. A client that only
50
+ accepts a URL fails with `does not support dynamic client registration`.
42
51
 
43
- A loopback redirect may use any available port, such as
44
- `http://127.0.0.1:6276/callback`, as long as it keeps the `/callback` path.
52
+ ## Ask your first question
45
53
 
46
- To test the sign-in flow without a client, run the MCP Inspector in a terminal,
47
- sign in to aVenture, and approve access. The Inspector lists the tools when sign-in
48
- succeeds.
54
+ - "Look up Stripe on aVenture and summarize its funding history."
55
+ - "Which company owns ramp.com, and who founded it?"
56
+ - "Find seed-stage climate software companies in Austin."
57
+ - "Who is Patrick Collison, and which companies is he connected to?"
49
58
 
50
- ```sh
51
- npx @modelcontextprotocol/inspector@2.6.0 --cli \
52
- --server-url https://mcp.aventure.vc/mcp \
53
- --client-id KL7mINzGk0le0QiD \
54
- --callback-url http://127.0.0.1:6276/callback \
55
- --method tools/list
56
- ```
59
+ ## Plans and usage
57
60
 
58
- ## Run the server yourself
61
+ Profile views, web searches, and research requests count toward your plan's monthly
62
+ allowance. When one runs out, the answer says which limit you reached and how to
63
+ upgrade. Ask your assistant to list aVenture plans with monthly and annual
64
+ prices, or to upgrade you. You can also manage your plan in
65
+ [subscription settings](https://aventure.vc/settings/subscription).
59
66
 
60
- The server requires Node.js 24.18 or later in the 24.x series. Installation fails
61
- on any other major version.
67
+ ## Advanced: run the server locally
68
+
69
+ Most people never need this. Run the server yourself only when your client can't
70
+ complete an OAuth sign-in or you need it inside your own network. It requires
71
+ Node.js 24.18.0 or later.
62
72
 
63
73
  ```sh
64
- npm install --global @aventurevc/mcp-server --@aventurevc:registry=https://registry.npmjs.org/
74
+ npm install --global @aventurevc/mcp-server
65
75
  aventure-mcp-server
66
76
  ```
67
77
 
68
- The `--@aventurevc:registry` flag makes npm install from the public npm registry
69
- even when your npm configuration maps the `@aventurevc` scope somewhere else. The
70
- package installs the same server under two command names, `aventure-mcp-server`
71
- and `aventure-mcp`.
72
-
73
- The server listens at `http://localhost:3333/mcp` and accepts connections from this
74
- computer only. Keep it running while your client is connected. It speaks
75
- Streamable HTTP, not stdio, so configure your client with a URL, not a command.
76
-
77
- | Setting | What it changes |
78
- | --- | --- |
79
- | `AVENTURE_MCP_PORT` environment variable | Listening port (default `3333`) |
80
- | `AVENTURE_MCP_PATH` environment variable | MCP route (default `/mcp`) |
81
- | `AVENTURE_MCP_JSON_LIMIT` environment variable | Maximum request body size |
82
- | `--host <address>` option | Network address to bind instead of `127.0.0.1`; `0.0.0.0` exposes the server to your network |
83
-
84
- Update the client URL when you change the port or route.
85
-
86
- ### Authenticate with a personal API key
87
-
88
- A self-hosted server has no OAuth sign-in and no credential of its own. Every
89
- request must carry a personal API key as a bearer token.
90
-
91
- 1. Sign in to aVenture and create a key in
92
- [aVenture API key settings](https://aventure.vc/settings/api-keys).
93
- 2. Store the key in your MCP client's secret storage. Never commit it to a file.
94
- 3. Configure the client to send `Authorization: Bearer <personal-api-key>`.
95
-
96
- For clients that read an `mcpServers` configuration:
78
+ The server listens at `http://localhost:3333/mcp`, which only clients on the same
79
+ machine can reach; a cloud app such as ChatGPT cannot. Create a key in
80
+ [API key settings](https://aventure.vc/settings/api-keys) and have your client send
81
+ it with every request:
97
82
 
98
83
  ```json
99
84
  {
@@ -101,57 +86,17 @@ For clients that read an `mcpServers` configuration:
101
86
  "aventure": {
102
87
  "type": "http",
103
88
  "url": "http://localhost:3333/mcp",
104
- "headers": {
105
- "Authorization": "Bearer <personal-api-key>"
106
- }
89
+ "headers": { "Authorization": "Bearer <your-api-key>" }
107
90
  }
108
91
  }
109
92
  }
110
93
  ```
111
94
 
112
- Replace `<personal-api-key>` using your client's secret interpolation syntax, which
113
- differs between clients. A request without a key receives status `401`.
114
-
115
- ## Verify the connection
116
-
117
- List the tools, call `aventure_status`, and then call `aventure_help`.
118
-
119
- | Tool | What it does |
120
- | --- | --- |
121
- | `aventure_status` | Returns API status, host, and the access your credential carries |
122
- | `aventure_help` | Finds the operation for a task and lists the inputs it needs |
123
- | `aventure_search` | Runs a search operation over companies, people, news, or content |
124
- | `aventure_lookup` | Resolves a name, URL, domain, slug, or other identifier to a record |
125
- | `aventure_read` | Reads one record or the records attached to it |
126
-
127
- Accounts with write permission also see `aventure_write` and `aventure_delete`,
128
- which change shared data immediately. The tool list reflects the signed-in
129
- account's permissions, and the API checks permission again on every call.
130
-
131
- ## Plans and usage
132
-
133
- Calls count toward your aVenture plan's usage. Some operations, such as
134
- plain-English search, need a plan that includes them; without one, the API
135
- responds with status `402`.
136
-
137
- - Compare plans on the [aVenture pricing page](https://aventure.vc/pricing).
138
- - Check your plan and current usage in
139
- [aVenture subscription settings](https://aventure.vc/settings/subscription).
140
-
141
- ## Diagnostics
142
-
143
- The server writes diagnostics to standard error. It sends no logs, metrics, or
144
- error reports to aVenture.
95
+ Store the key in your client's secret storage, not in a file you commit.
96
+ `AVENTURE_MCP_PORT` and `AVENTURE_MCP_PATH` change the port and route.
145
97
 
146
98
  ## Documentation
147
99
 
148
100
  - [MCP quickstart](https://docs.aventure.vc/mcp)
149
- - [Authentication guide](https://docs.aventure.vc/authentication)
150
- - [Error reference](https://docs.aventure.vc/errors)
151
- - [API reference](https://docs.aventure.vc/api-reference)
152
-
153
- The tool catalog is generated from the public aVenture OpenAPI specification.
154
-
155
- ## License
156
-
157
- Apache License 2.0. See the [LICENSE file](LICENSE).
101
+ - [Authentication and plans](https://docs.aventure.vc/authentication)
102
+ - [Errors](https://docs.aventure.vc/errors)