docs(sourcegraph): add docs for the MCP server #1351
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
| - `limit` - Maximum results per page (optional, default 50) | ||
| - `after`/`before` - Pagination cursors (optional) | ||
|
|
||
| ### Code Search |
There was a problem hiding this comment.
What do you think @janhartman ?
There was a problem hiding this comment.
Seems pretty good! I wonder if we should generate full descriptions from our code and put them in the docs (collapsed by default). Could be valuable for an interested reader as otherwise they'd have to connect to the server first. But maybe hiding all the details is a feature? 😆
docs/api/mcp/index.mdx
Outdated
|
|
||
| #### Prerequisites | ||
|
|
||
| Before using the device flow, you must create an OAuth application in your Sourcegraph instance: |
There was a problem hiding this comment.
We can predefine oauth clients as well, I wonder if we should do that.
@unknwon do you have thoughts here?
Then users would just need to copy the details here. No way to get a client secret then, so PKCE or RFC8628 device flow auth are required; which is probably what most clients should do anyways.
There was a problem hiding this comment.
My 2 cents: If we are aiming enterprises to use MCP feature to start with, let's ask users to create OAuth applications for now because our OAuth scopes are currently still all or nothing. Ideally, we could give away some less sensitive scopes OOTB for a predefined client, then if users want to grant more scopes, they can choose to create a different OAuth client for their MCP needs.
@janhartman What do you mean by full descriptions? Do you mean including the full tool description here (but collapsed)? |
jamesmcnamara
force-pushed
the
jamesmcnamara-splf-1364-add-public-docs-for-sg-mcp
branch
from
f6daeef to
9a58daa
Compare
jamesmcnamara
deleted the
jamesmcnamara-splf-1364-add-public-docs-for-sg-mcp
branch
Adds documentation for the Sourcegraph MCP server added in v6.8
Pull Request approval
You will need to get your PR approved by at least one member of the Sourcegraph team. For reviews of docs formatting, styles, and component usage, please tag the docs team via the #docs Slack channel.